Skip to content

Interface: FunnelCalc ​

Experimental

Funnel calcdata: bar's calc (bars centered on zero) plus the stage percentages.

Extends ​

Properties ​

PropertyModifierTypeDescriptionInherited from
barspublicStackOutputExperimental Layout and stacking result (updated by crossTraceCalc).BarCalc.bars
basereadonlyFloat64ArrayExperimental User base per bar (calc space), 0 where unset.BarCalc.base
connectNextreadonlyUint8ArrayExperimental 1 when a connector goes from this stage to the next (Plotly's cNext).-
endspublicobjectExperimental Bar ends (x, y linear): where error bars attach (center of the bar's far edge).BarCalc.ends
ends.xpublicFloat64Array--
ends.ypublicFloat64Array--
errorXpublicErrorBarCalc | undefinedExperimental Error bars along x and y, at the bar ends (after stacking, as in Plotly).BarCalc.errorX
errorYpublicErrorBarCalc | undefinedExperimentalBarCalc.errorY
floorpublicbooleanExperimental Some bar starts at -Infinity (log axis without a positive base): draw it from the axis floor.BarCalc.floor
hasBasereadonlyUint8ArrayExperimental 1 where the user set a base for that bar.BarCalc.hasBase
lengthreadonlynumberExperimentalBarCalc.length
minSpacing?readonlynumberExperimental 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
orientationreadonly"v" | "h"ExperimentalBarCalc.orientation
overlayAlone?readonlybooleanExperimental 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
percentInitialreadonlyFloat64ArrayExperimental Value as a fraction of the first stage's (Plotly's begR).-
percentPreviousreadonlyFloat64ArrayExperimental Value as a fraction of the previous stage with a value (Plotly's difR).-
percentTotalreadonlyFloat64ArrayExperimental Value as a fraction of the trace's total (Plotly's sumR).-
period?readonlyobjectExperimental 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.endsreadonlyFloat64Array--
period.startsreadonlyFloat64Array--
posreadonlyFloat64ArrayExperimental Positions (linear coordinates of the position axis); NaN where a bar cannot be placed.BarCalc.pos
positionValues?readonlyArrayLike<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
posTypereadonlyAxisType | undefinedExperimental Position-axis type, when known.BarCalc.posType
s0publicFloat64ArrayExperimental Bar start / end on the size axis, linear. -Infinity: starts below a log axis.BarCalc.s0
s1publicFloat64ArrayExperimentalBarCalc.s1
sizereadonlyFloat64ArrayExperimental Lengths in calc space of the size axis (ms on date axes, raw values on log axes).BarCalc.size
sizeTypereadonlyAxisType | undefinedExperimental Size-axis type, when known.BarCalc.sizeType

Released under the MIT License.