Skip to content

Type Alias: Scatter3dTrace ​

ts
type Scatter3dTrace = CommonTraceAttributes & object;

Markers, lines and text at x, y, z in a 3D scene (layout.scene), with colorscales, error bars, wall shadows (projection) and a surface through the points (surfaceaxis).

Type Declaration ​

NameTypeDescription
connectgaps?booleanConnect lines across missing (null, NaN) points instead of breaking them.
error_x?Scatter3dTraceErrorXError bars along the x axis, drawn as 3D segments through the points.
error_y?Scatter3dTraceErrorYError bars along the y axis, drawn as 3D segments through the points.
error_z?Scatter3dTraceErrorZError bars along the z axis, drawn as 3D segments through the points.
line?Scatter3dTraceLineLine style (mode lines).
marker?Scatter3dTraceMarkerMarker style (mode markers).
mode?| "lines" | "markers" | "text" | "lines+markers" | "lines+text" | "markers+lines" | "markers+text" | "text+lines" | "text+markers" | "lines+markers+text" | "lines+text+markers" | "markers+lines+text" | "markers+text+lines" | "text+lines+markers" | "text+markers+lines" | "none"Drawing mode: any of 'lines', 'markers', 'text' joined by +, or 'none'.
projection?Scatter3dTraceProjectionShadows of the markers on the scene's walls.
scene?"scene" | `scene${number}`The 3D scene this trace is drawn in: 'scene' (layout.scene), 'scene2' (layout.scene2), ….
surfaceaxis?-1 | 0 | 1 | 2Fill a surface through the points, triangulated (Delaunay) in the plane perpendicular to this axis (0: x, 1: y, 2: z); -1 for none.
surfacecolor?stringColor of the surfaceaxis surface. Defaults to the line or marker color.
text?PerPoint<string | number>Text per point: the labels of mode text, and hover text.
textfont?ScatterTraceTextfontFont of the text labels (mode text). Defaults to layout.font.
textposition?PerPoint< | "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right">Position of each text label around its point (and marker), or one per point; the labels face the camera.
texttemplate?PerPoint<string | number>Template for the text labels, e.g. '%{y:.2f}' or `'%{x
type"scatter3d"Trace type.
x?DataColumnThe x coordinates (numbers, dates or categories, per the scene's x axis).
xhoverformat?stringd3-format (or d3-time-format on date axes) of the x values in hover labels, overriding the scene axis' hoverformat.
y?DataColumnThe y coordinates (numbers, dates or categories, per the scene's y axis).
yhoverformat?stringd3-format (or d3-time-format on date axes) of the y values in hover labels, overriding the scene axis' hoverformat.
z?DataColumnThe z coordinates (numbers, dates or categories, per the scene's z axis).
zhoverformat?stringd3-format (or d3-time-format on date axes) of the z values in hover labels, overriding the scene axis' hoverformat.

Released under the MIT License.