Waterfall

data

An array of { category, value?, kind? }. kind is delta, subtotal, or total.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• WaterfallData

  Type definition

width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

height

Chart height in pixels. Allow space for axes, titles, and the legend.

brandLogo

The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

brandPosition

The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.

xAxis

Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• XAxisInput

  Type definition

yAxis

Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• YAxisInput

  Type definition

gridLines

Grid lines: the value axis's on by default, the category axis's off.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianGridLinesInput

  Type definition

crosshair

Crosshair that follows the cursor across the plot.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianCrosshairInput

  Type definition

zoom

Zoom (Storybook parity, 2026-09-10): 'x' | 'y' | 'xy' | true (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (+ / - / Escape) on the primary axes; an object refines mode / drag / keyboard / minRangePx / resetButton / pan / wheel / pinch / inside. Off by default; the methods (zoomTo / zoomBy / panBy / resetZoom) work regardless of the gesture switches.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianZoomInput

  Type definition

yMin

Set as an HTML attribute or JavaScript property. type: number.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

yMax

Set as an HTML attribute or JavaScript property. type: number.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

padding

The automatic domain pads the value span by this share (default 5 %); zero is always inside.

upColor

The bar colours: a rising delta, a falling delta, a total / subtotal; the connectors; the hovered / focused bar.

downColor

Set as an HTML attribute or JavaScript property. type: string.

totalColor

Set as an HTML attribute or JavaScript property. type: string.

connectorColor

Set as an HTML attribute or JavaScript property. type: string.

activeColor

Set as an HTML attribute or JavaScript property. type: string.

barWidth

The bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px.

barMinPx

Set as an HTML attribute or JavaScript property. type: number.

barMaxPx

Set as an HTML attribute or JavaScript property. type: number.

connectorWidth

The connector's thickness in CSS px, and its switch.

showConnectors

Set as an HTML attribute or JavaScript property. type: boolean.

showTotal

Append a grand-total bar after the last step (unless it already is a total), named total-label ().

totalLabel

Set as an HTML attribute or JavaScript property. type: string.

detectResult

Recognise a last step given as a plain value equal to the running total as the RESULT bar (a total from zero; detected: true); off → it stays a delta.

lastResult

True: the last merged step is a result spanning zero and the preceding running total, ignoring its value/colour. False: disable detection, preserving explicit datum kinds. Omitted: use detect-result.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

showLabels

The value labels (off by default): label-mode value (a delta's signed change, a total's running total) / running / both; labelFormat(bar) replaces the text.

labelMode

Allowed values: value, running, both. Default: 'value'.

• WaterfallLabelMode

  Type definition

labelFormat

Pass as a JavaScript property. type: (bar: WaterfallBar) => string.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• WaterfallBar

  Type definition

chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

chartSubtitle

The subtitle inside the chart.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

enableMouseTracking

Set as an HTML attribute or JavaScript property. type: boolean.

tooltip

The bar tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianTooltipInput

  Type definition

tooltipEnabled

Set as an HTML attribute or JavaScript property. type: boolean.

tooltipFormat

Pass as a JavaScript property. type: (detail: WaterfallPointEventDetail) => string.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• WaterfallPointEventDetail

  Type definition

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

• WaterfallEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• WaterfallAnimationType

  Type definition

streamSource

§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• WaterfallStreamSource

  Type definition

streamMax

Steps tracked by the internal stream at most (the oldest leave as windowSlid).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

streamWindow

The newest N streamed steps the chart renders (the whole buffer when unset).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

• WaterfallEngineMode

  Type definition

unavailable

Allowed values: fallback, error. Default: 'fallback'.

• WaterfallUnavailableBehaviour

  Type definition

rendered

Every drawn frame; engine is the engine status (requested / effective / code / the governing license feature).

Event name: rendered. Names are case-sensitive. Read the payload from detail on CustomEvent<WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus }>.

chart.addEventListener('rendered', event => {
  console.log(event.detail); // WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus }
});

• WaterfallRenderResult

  Type definition

• WaterfallEngineTier

  Type definition

• ChartEngineStatus

  Type definition

pointClick

A point selection event. Read the selected data and index from CustomEvent.detail.

Event name: pointClick. Names are case-sensitive. Read the payload from detail on CustomEvent<WaterfallPointEventDetail>.

chart.addEventListener('pointClick', event => {
  console.log(event.detail); // WaterfallPointEventDetail
});

• WaterfallPointEventDetail

  Type definition

pointHover

CustomEvent.detail type: WaterfallPointEventDetail | null. Event names are case-sensitive.

Event name: pointHover. Names are case-sensitive. Read the payload from detail on CustomEvent<WaterfallPointEventDetail | null>.

chart.addEventListener('pointHover', event => {
  console.log(event.detail); // WaterfallPointEventDetail | null
});

• WaterfallPointEventDetail

  Type definition

crosshairMove

CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.

Event name: crosshairMove. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianCrosshairEventDetail | null>.

chart.addEventListener('crosshairMove', event => {
  console.log(event.detail); // CartesianCrosshairEventDetail | null
});

• CartesianCrosshairEventDetail

  Type definition

pointContextMenu

CustomEvent.detail type: ChartPointContextMenuEventDetail<WaterfallPointEventDetail>. Event names are case-sensitive.

Event name: pointContextMenu. Names are case-sensitive. Read the payload from detail on CustomEvent<ChartPointContextMenuEventDetail<WaterfallPointEventDetail>>.

chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<WaterfallPointEventDetail>
});

• ChartPointContextMenuEventDetail

  Type definition

• WaterfallPointEventDetail

  Type definition

appended

CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.

Event name: appended. Names are case-sensitive. Read the payload from detail on CustomEvent<{ count: number; replaced: number }>.

chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number; replaced: number }
});

windowSlid

CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

Event name: windowSlid. Names are case-sensitive. Read the payload from detail on CustomEvent<{ dropped: number }>.

chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});

tooltipShow

The shared tooltip events (the controller emits them).

Event name: tooltipShow. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipEventDetail>.

chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});

• CartesianTooltipEventDetail

  Type definition

tooltipHide

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: tooltipHide. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});

tooltipAction

CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.

Event name: tooltipAction. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipActionEventDetail>.

chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});

• CartesianTooltipActionEventDetail

  Type definition

chartAnimationStart

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationStart. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});

chartAnimationEnd

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationEnd. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});

chartAnimationInterrupted

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationInterrupted. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});

zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.

Event name: zoomChange. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianZoomChangeEventDetail>.

chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});

• CartesianZoomChangeEventDetail

  Type definition

getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

getDataTable(): Promise<ChartDataTable>

Return type: Promise<ChartDataTable>. Call the method after element registration and await its Promise result.

• ChartDataTable

  Type definition

redraw

Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.

redraw(): Promise<WaterfallRenderResult>

Return type: Promise<WaterfallRenderResult>. Call the method after element registration and await its Promise result.

• WaterfallRenderResult

  Type definition

getActiveTier

An asynchronous method. Check the argument and return types below.

getActiveTier(): Promise<WaterfallEngineTier>

Return type: Promise<WaterfallEngineTier>. Call the method after element registration and await its Promise result.

• WaterfallEngineTier

  Type definition

getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

getUnavailableReason(): Promise<string | undefined>

Return type: Promise<string | undefined>. Call the method after element registration and await its Promise result.

setData

Replace the bar set.

setData(data: WaterfallData): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• WaterfallData

  Type definition

appendPoint

Append one value to the stream. Check the argument type and the licensing requirements for streaming.

appendPoint(datum: WaterfallDatumInput): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• WaterfallDatumInput

  Type definition

appendBatch

Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

appendBatch(data: ReadonlyArray<WaterfallDatumInput>): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• WaterfallDatumInput

  Type definition

shift

Drop the oldest streamed steps (the data bars are not the stream).

shift(count: number): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

replace

Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).

replace(data: ReadonlyArray<WaterfallDatumInput>): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• WaterfallDatumInput

  Type definition

getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

getStreamSource(): Promise<WaterfallStreamSource | undefined>

Return type: Promise<WaterfallStreamSource | undefined>. Call the method after element registration and await its Promise result.

• WaterfallStreamSource

  Type definition

setAnimation

An asynchronous method. Check the argument and return types below.

setAnimation(options: { duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType }): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• WaterfallEasing

  Type definition

• WaterfallAnimationType

  Type definition

pauseAnimation

Pause the current animation.

pauseAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

resumeAnimation

Resume a paused animation.

resumeAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

replayAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

hitTest

The bar under a host-local CSS point (the nearest slot, within half a pitch), or null.

hitTest(cssX: number, cssY: number): Promise<WaterfallPointEventDetail | null>

Return type: Promise<WaterfallPointEventDetail | null>. Call the method after element registration and await its Promise result.

• WaterfallPointEventDetail

  Type definition

getBar

The normalised bar at an index (null outside).

getBar(index: number): Promise<WaterfallBar | null>

Return type: Promise<WaterfallBar | null>. Call the method after element registration and await its Promise result.

• WaterfallBar

  Type definition

getBarByCategory

An asynchronous method. Check the argument and return types below.

getBarByCategory(category: string): Promise<WaterfallBar | null>

Return type: Promise<WaterfallBar | null>. Call the method after element registration and await its Promise result.

• WaterfallBar

  Type definition

getBarCount

An asynchronous method. Check the argument and return types below.

getBarCount(): Promise<number>

Return type: Promise<number>. Call the method after element registration and await its Promise result.

getBars

An asynchronous method. Check the argument and return types below.

getBars(): Promise<WaterfallBar[]>

Return type: Promise<WaterfallBar[]>. Call the method after element registration and await its Promise result.

• WaterfallBar

  Type definition

getCategories

An asynchronous method. Check the argument and return types below.

getCategories(): Promise<string[]>

Return type: Promise<string[]>. Call the method after element registration and await its Promise result.

getExtent

An asynchronous method. Check the argument and return types below.

getExtent(): Promise<WaterfallExtent>

Return type: Promise<WaterfallExtent>. Call the method after element registration and await its Promise result.

• WaterfallExtent

  Type definition

getDomain

The data domain the grid spans.

getDomain(): Promise<WaterfallDomain>

Return type: Promise<WaterfallDomain>. Call the method after element registration and await its Promise result.

• WaterfallDomain

  Type definition

getRunningTotal

The running total after the last bar (0 without bars).

getRunningTotal(): Promise<number>

Return type: Promise<number>. Call the method after element registration and await its Promise result.

showTooltipAtIndex

Open the tooltip on a bar (the facade's showTooltipAtPoint routes here); null off the bars or with the tooltip off.

showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>

Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianTooltipEventDetail

  Type definition

hideTooltip

Close the currently visible tooltip.

hideTooltip(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

focusBarAt

Move the keyboard focus ring to a bar (null off the bars); emits pointHover like the walk.

focusBarAt(index: number): Promise<WaterfallPointEventDetail | null>

Return type: Promise<WaterfallPointEventDetail | null>. Call the method after element registration and await its Promise result.

• WaterfallPointEventDetail

  Type definition

zoomTo

Zoom to explicit windows: x / y as { min, max } or [min, max] (null clears that orientation; x is in slots — bar i sits at i); xAxis / yAxis name the axis by id or slot index (default: the primary axis).

zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

• CartesianZoomRequest

  Type definition

zoomBy

Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).

zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

panBy

Slide the zoomed windows by data units ({ x?, y? } — x in slots); a no-op at the full extent.

panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

resetZoom

Reset the zoomed or panned range to the original data range.

resetZoom(): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

getZoom

Read the current zoom range. Check the return type's nullability and the range for each axis.

getZoom(): Promise<CartesianZoomState | null>

Return type: Promise<CartesianZoomState | null>. Call the method after element registration and await its Promise result.

• CartesianZoomState

  Type definition

getZoomExtent

The full extent (and key) of the primary — or the named — master axes (x: the slot range −0.5 … n − 0.5).

getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>

Return type: Promise<CartesianZoomExtentDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition

getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported.

getEngineStatus(): Promise<ChartEngineStatus>

Return type: Promise<ChartEngineStatus>. Call the method after element registration and await its Promise result.

• ChartEngineStatus

  Type definition