Type Alias: Bar3dTrace
ts
type Bar3dTrace = Omit<CommonTraceAttributes, 'hoverinfo'> & object;True 3D bars on an x/y grid (a Holochart extension): lit boxes of height z at (x, y), categorical or numeric, stacked across traces with stackgroup, colored per bar or by height through a colorscale, one instanced draw call per trace.
Type Declaration
| Name | Type | Description |
|---|---|---|
base? | PerPointNumber | Where the bars start on the z axis (z data units), or one per bar. Default 0. In a stackgroup, only the bottom bar of each stack uses it. |
depth? | PerPointNumber | Bar depth along the y axis, in y axis units (one category is 1, dates in ms), or one per bar. Default: 0.8 of the smallest distance between the trace's distinct y positions (1 with a single position). Minimum: 0 |
hoverinfo? | PerPoint< | "x" | "y" | "z" | "base" | "text" | "name" | `${"x" | "y" | "z" | "base" | "text" | "name"}+${string}` | "all" | "none" | "skip"> | Which fields hover labels show: the position (x, y), the height (z), the bar's base (when it has one or is stacked), text and the trace name; 'skip' also turns hover events off. |
lighting? | Bar3dTraceLighting | Plotly's lighting model: coefficients of the ambient, diffuse and specular light. With scene.lighting, they scale the scene's lights. |
lightposition? | Bar3dTraceLightposition | Position of the light (Plotly's model, without scene.lighting), in clip space: it moves with the view. |
marker? | Bar3dTraceMarker | Bar style. |
material? | Bar3dTraceMaterial | The material of the surface (Holochart extension). Plotly figures keep the default, plotly. |
scene? | "scene" | `scene${number}` | The 3D scene this trace is drawn in: 'scene' (layout.scene), 'scene2' (layout.scene2), …. |
stackgroup? | string | Stack this trace's bars on those of earlier bar3d traces of the same scene with the same stackgroup (Plotly's barmode: 'stack', per trace like scatter's stackgroup): bars at the same (x, y) stack in trace order. Empty: no stacking (bars at the same position overlap). |
text? | PerPoint<string | number> | Text per bar, shown in hover labels and as %{text} in templates. |
type | "bar3d" | Trace type. |
width? | PerPointNumber | Bar width along the x axis, in x axis units (one category is 1, dates in ms), or one per bar. Default: 0.8 of the smallest distance between the trace's distinct x positions (1 with a single position). Minimum: 0 |
x? | DataColumn | X position of each bar's center (numbers, dates or categories, per the scene's x axis). |
xhoverformat? | string | d3 number format of x values in hover labels. Default: the scene's x axis format. |
y? | DataColumn | Y position of each bar's center (numbers, dates or categories, per the scene's y axis). |
yhoverformat? | string | d3 number format of y values in hover labels. Default: the scene's y axis format. |
z? | DataColumn | Bar heights along the z axis, from base (or the top of the bar below it with stackgroup). Negative heights go down. |
zhoverformat? | string | d3 number format of z values in hover labels. Default: the scene's z axis format. |