Interface: WaterfallCalc
Experimental
Waterfall calcdata: bar's calc (sizes are running totals) plus the waterfall values.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
bars | public | StackOutput | Experimental Layout and stacking result (updated by crossTraceCalc). | BarCalc.bars |
base | readonly | Float64Array | Experimental User base per bar (calc space), 0 where unset. | BarCalc.base |
connectNext | readonly | Uint8Array | Experimental 1 when a connector goes from this bar to the next (Plotly's cNext). | - |
delta | readonly | Float64Array | Experimental The bar's own value (0 when missing; Plotly's rawS). | - |
direction | readonly | Uint8Array | Experimental Per bar: INCREASING, DECREASING or TOTALS. | - |
ends | public | object | Experimental Bar ends (x, y linear): where error bars attach (center of the bar's far edge). | BarCalc.ends |
ends.x | public | Float64Array | - | - |
ends.y | public | Float64Array | - | - |
errorX | public | ErrorBarCalc | undefined | Experimental Error bars along x and y, at the bar ends (after stacking, as in Plotly). | BarCalc.errorX |
errorY | public | ErrorBarCalc | undefined | Experimental | BarCalc.errorY |
final | readonly | Float64Array | Experimental base + the running total after the bar (Plotly's v). | - |
floor | public | boolean | Experimental Some bar starts at -Infinity (log axis without a positive base): draw it from the axis floor. | BarCalc.floor |
hasBase | readonly | Uint8Array | Experimental 1 where the user set a base for that bar. | BarCalc.hasBase |
hasTotals | readonly | boolean | Experimental Some bar is a sum bar (the legend then shows three directions). | - |
isSum | readonly | Uint8Array | Experimental 1 for total and absolute bars (Plotly's isSum). | - |
length | readonly | number | Experimental | BarCalc.length |
minSpacing? | readonly | number | Experimental A minimum position spacing (Plotly's width1): a histogram collapsed to one bin knows its bin width, which then sizes the bars. Unset for bars. | BarCalc.minSpacing |
orientation | readonly | "v" | "h" | Experimental | BarCalc.orientation |
overlayAlone? | readonly | boolean | Experimental In overlay mode, lay this trace out on its own, with its own position spacing (Plotly lays out every overlaid trace alone): overlaid histograms keep their own bin widths. Unset for bars, which share one layout. | BarCalc.overlayAlone |
period? | readonly | object | Experimental With xperiod (yperiod for horizontal bars): the period of each bar on the position axis (linear), which pos is aligned within. Hover along that axis catches a bar over its period (Plotly's bar/hover.js). Unset without a period. | BarCalc.period |
period.ends | readonly | Float64Array | - | - |
period.starts | readonly | Float64Array | - | - |
pos | readonly | Float64Array | Experimental Positions (linear coordinates of the position axis); NaN where a bar cannot be placed. | BarCalc.pos |
positionValues? | readonly | ArrayLike<unknown> | Experimental The position of each bar as label and template value (%{label}, %{x}), when it is not the trace's position coordinate: a histogram's bin centers (calc space). Unset for bars. | BarCalc.positionValues |
posType | readonly | AxisType | undefined | Experimental Position-axis type, when known. | BarCalc.posType |
s0 | public | Float64Array | Experimental Bar start / end on the size axis, linear. -Infinity: starts below a log axis. | BarCalc.s0 |
s1 | public | Float64Array | Experimental | BarCalc.s1 |
size | readonly | Float64Array | Experimental Lengths in calc space of the size axis (ms on date axes, raw values on log axes). | BarCalc.size |
sizeType | readonly | AxisType | undefined | Experimental Size-axis type, when known. | BarCalc.sizeType |