# Waterfall

Show how increases and decreases accumulate into a final value.

Canonical: https://chart.syidax.com/docs/components/waterfall/

<a id="overview"></a>

## sy-waterfall-chart

Explain the opening value, changes, and total for revenue, costs, or inventory.

total and subtotal differ from ordinary changes. Do not add a total again as a delta.

Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements.

| Input | Data description |
| --- | --- |
| `data` | An array of { category, value?, kind? }. kind is delta, subtotal, or total. |

- [Run in Components](https://chart.syidax.com/charts/waterfall) — Change options and view framework-specific code
- [Shared installation and integration](https://chart.syidax.com/docs/getting-started.md)

<a id="example"></a>

## Complete implementation example

```html
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-waterfall-chart.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-waterfall-chart",
      "props": {
        "data": [
          {
            "category": "Opening",
            "value": 100
          },
          {
            "category": "New",
            "value": 45
          },
          {
            "category": "Cancellations",
            "value": -20
          },
          {
            "category": "Additions",
            "value": 15
          },
          {
            "category": "Total",
            "kind": "total"
          }
        ],
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'waterfall example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', onEvent);
  const observer = new ResizeObserver(([entry]) => {
    const width = Math.max(160, Math.floor(entry.contentRect.width));
    elements.forEach(element => { element.width = width; });
  });
  observer.observe(container);

  // In an SPA, call this function when the view is disposed.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('pointClick', onEvent);
    container.replaceChildren();
  }
</script>
```

<a id="props"></a>

## Properties

<a id="property-data"></a>

### data

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

| Item | Value |
| --- | --- |
| JavaScript property | `data` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `WaterfallData` |
| Default | `undefined` |

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

- [WaterfallData](https://chart.syidax.com/docs/types/WaterfallData.md) — Type definition

<a id="property-width"></a>

### width

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

| Item | Value |
| --- | --- |
| JavaScript property | `width` |
| HTML attribute | `width` |
| Type | `number` |
| Default | `900` |

<a id="property-height"></a>

### height

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

| Item | Value |
| --- | --- |
| JavaScript property | `height` |
| HTML attribute | `height` |
| Type | `number` |
| Default | `360` |

<a id="property-brandLogo"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `brandLogo` |
| HTML attribute | `brand-logo` |
| Type | `string` |
| Default | `undefined` |

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

<a id="property-brandPosition"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `brandPosition` |
| HTML attribute | `brand-position` |
| Type | `'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` |
| Default | `'bottom-right'` |
| Allowed values | `top-left`, `top-right`, `bottom-left`, `bottom-right` |

<a id="property-xAxis"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `xAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `XAxisInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

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

- [XAxisInput](https://chart.syidax.com/docs/types/XAxisInput.md) — Type definition

<a id="property-yAxis"></a>

### yAxis

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

| Item | Value |
| --- | --- |
| JavaScript property | `yAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `YAxisInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

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

- [YAxisInput](https://chart.syidax.com/docs/types/YAxisInput.md) — Type definition

<a id="property-gridLines"></a>

### gridLines

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

| Item | Value |
| --- | --- |
| JavaScript property | `gridLines` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianGridLinesInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

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

- [CartesianGridLinesInput](https://chart.syidax.com/docs/types/CartesianGridLinesInput.md) — Type definition

<a id="property-crosshair"></a>

### crosshair

Crosshair that follows the cursor across the plot.

| Item | Value |
| --- | --- |
| JavaScript property | `crosshair` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianCrosshairInput` |
| Default | `undefined` |

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

- [CartesianCrosshairInput](https://chart.syidax.com/docs/types/CartesianCrosshairInput.md) — Type definition

<a id="property-zoom"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `zoom` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianZoomInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside` |

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

- [CartesianZoomInput](https://chart.syidax.com/docs/types/CartesianZoomInput.md) — Type definition

<a id="property-yMin"></a>

### yMin

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMin` |
| HTML attribute | `y-min` |
| Type | `number` |
| Default | `undefined` |

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

<a id="property-yMax"></a>

### yMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMax` |
| HTML attribute | `y-max` |
| Type | `number` |
| Default | `undefined` |

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

<a id="property-padding"></a>

### padding

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

| Item | Value |
| --- | --- |
| JavaScript property | `padding` |
| HTML attribute | `padding` |
| Type | `number` |
| Default | `0.05` |

<a id="property-upColor"></a>

### upColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `upColor` |
| HTML attribute | `up-color` |
| Type | `string` |
| Default | `DEFAULT_UP_COLOR` |

<a id="property-downColor"></a>

### downColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `downColor` |
| HTML attribute | `down-color` |
| Type | `string` |
| Default | `DEFAULT_DOWN_COLOR` |

<a id="property-totalColor"></a>

### totalColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `totalColor` |
| HTML attribute | `total-color` |
| Type | `string` |
| Default | `DEFAULT_TOTAL_COLOR` |

<a id="property-connectorColor"></a>

### connectorColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `connectorColor` |
| HTML attribute | `connector-color` |
| Type | `string` |
| Default | `DEFAULT_CONNECTOR_COLOR` |

<a id="property-activeColor"></a>

### activeColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `activeColor` |
| HTML attribute | `active-color` |
| Type | `string` |
| Default | `DEFAULT_ACTIVE_COLOR` |

<a id="property-barWidth"></a>

### barWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `barWidth` |
| HTML attribute | `bar-width` |
| Type | `number` |
| Default | `WATERFALL_DEFAULT_WIDTH_RATIO` |

<a id="property-barMinPx"></a>

### barMinPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `barMinPx` |
| HTML attribute | `bar-min-px` |
| Type | `number` |
| Default | `WATERFALL_DEFAULT_MIN_PX` |

<a id="property-barMaxPx"></a>

### barMaxPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `barMaxPx` |
| HTML attribute | `bar-max-px` |
| Type | `number` |
| Default | `WATERFALL_DEFAULT_MAX_PX` |

<a id="property-connectorWidth"></a>

### connectorWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `connectorWidth` |
| HTML attribute | `connector-width` |
| Type | `number` |
| Default | `1` |

<a id="property-showConnectors"></a>

### showConnectors

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

| Item | Value |
| --- | --- |
| JavaScript property | `showConnectors` |
| HTML attribute | `show-connectors` |
| Type | `boolean` |
| Default | `true` |

<a id="property-showTotal"></a>

### showTotal

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

| Item | Value |
| --- | --- |
| JavaScript property | `showTotal` |
| HTML attribute | `show-total` |
| Type | `boolean` |
| Default | `false` |

<a id="property-totalLabel"></a>

### totalLabel

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

| Item | Value |
| --- | --- |
| JavaScript property | `totalLabel` |
| HTML attribute | `total-label` |
| Type | `string` |
| Default | `WATERFALL_DEFAULT_TOTAL_LABEL` |

<a id="property-detectResult"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `detectResult` |
| HTML attribute | `detect-result` |
| Type | `boolean` |
| Default | `true` |

<a id="property-lastResult"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `lastResult` |
| HTML attribute | `last-result` |
| Type | `boolean` |
| Default | `undefined` |

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

<a id="property-showLabels"></a>

### 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.

| Item | Value |
| --- | --- |
| JavaScript property | `showLabels` |
| HTML attribute | `show-labels` |
| Type | `boolean` |
| Default | `false` |

<a id="property-labelMode"></a>

### labelMode

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

| Item | Value |
| --- | --- |
| JavaScript property | `labelMode` |
| HTML attribute | `label-mode` |
| Type | `WaterfallLabelMode` |
| Default | `'value'` |
| Allowed values | `value`, `running`, `both` |

- [WaterfallLabelMode](https://chart.syidax.com/docs/types/WaterfallLabelMode.md) — Type definition

<a id="property-labelFormat"></a>

### labelFormat

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

| Item | Value |
| --- | --- |
| JavaScript property | `labelFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(bar: WaterfallBar) => string` |
| Default | `undefined` |

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

- [WaterfallBar](https://chart.syidax.com/docs/types/WaterfallBar.md) — Type definition

<a id="property-chartTitle"></a>

### chartTitle

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

| Item | Value |
| --- | --- |
| JavaScript property | `chartTitle` |
| HTML attribute | `chart-title` |
| Type | `string` |
| Default | `undefined` |

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

<a id="property-chartSubtitle"></a>

### chartSubtitle

The subtitle inside the chart.

| Item | Value |
| --- | --- |
| JavaScript property | `chartSubtitle` |
| HTML attribute | `chart-subtitle` |
| Type | `string` |
| Default | `undefined` |

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

<a id="property-enableMouseTracking"></a>

### enableMouseTracking

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

| Item | Value |
| --- | --- |
| JavaScript property | `enableMouseTracking` |
| HTML attribute | `enable-mouse-tracking` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltip"></a>

### tooltip

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

| Item | Value |
| --- | --- |
| JavaScript property | `tooltip` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianTooltipInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

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

- [CartesianTooltipInput](https://chart.syidax.com/docs/types/CartesianTooltipInput.md) — Type definition

<a id="property-tooltipEnabled"></a>

### tooltipEnabled

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

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipEnabled` |
| HTML attribute | `tooltip-show` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltipFormat"></a>

### tooltipFormat

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

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(detail: WaterfallPointEventDetail) => string` |
| Default | `undefined` |

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

- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="property-animated"></a>

### animated

Whether to animate initial display and data changes.

| Item | Value |
| --- | --- |
| JavaScript property | `animated` |
| HTML attribute | `animate` |
| Type | `boolean` |
| Default | `false` |

<a id="property-animationDuration"></a>

### animationDuration

Animation duration in milliseconds.

| Item | Value |
| --- | --- |
| JavaScript property | `animationDuration` |
| HTML attribute | `animation-duration` |
| Type | `number` |
| Default | `600` |

<a id="property-animationEasing"></a>

### animationEasing

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

| Item | Value |
| --- | --- |
| JavaScript property | `animationEasing` |
| HTML attribute | `animation-easing` |
| Type | `WaterfallEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [WaterfallEasing](https://chart.syidax.com/docs/types/WaterfallEasing.md) — Type definition

<a id="property-animationType"></a>

### animationType

Allowed values: initial, update. Default: undefined.

| Item | Value |
| --- | --- |
| JavaScript property | `animationType` |
| HTML attribute | `animation-type` |
| Type | `WaterfallAnimationType` |
| Default | `undefined` |
| Allowed values | `initial`, `update` |

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

- [WaterfallAnimationType](https://chart.syidax.com/docs/types/WaterfallAnimationType.md) — Type definition

<a id="property-streamSource"></a>

### streamSource

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

| Item | Value |
| --- | --- |
| JavaScript property | `streamSource` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `WaterfallStreamSource` |
| Default | `undefined` |

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

- [WaterfallStreamSource](https://chart.syidax.com/docs/types/WaterfallStreamSource.md) — Type definition

<a id="property-streamMax"></a>

### streamMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `streamMax` |
| HTML attribute | `stream-max` |
| Type | `number` |
| Default | `undefined` |

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

<a id="property-streamWindow"></a>

### streamWindow

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

| Item | Value |
| --- | --- |
| JavaScript property | `streamWindow` |
| HTML attribute | `stream-window` |
| Type | `number` |
| Default | `undefined` |

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

<a id="property-engine"></a>

### engine

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

| Item | Value |
| --- | --- |
| JavaScript property | `engine` |
| HTML attribute | `engine` |
| Type | `WaterfallEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

- [WaterfallEngineMode](https://chart.syidax.com/docs/types/WaterfallEngineMode.md) — Type definition

<a id="property-unavailable"></a>

### unavailable

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

| Item | Value |
| --- | --- |
| JavaScript property | `unavailable` |
| HTML attribute | `unavailable` |
| Type | `WaterfallUnavailableBehaviour` |
| Default | `'fallback'` |
| Allowed values | `fallback`, `error` |

- [WaterfallUnavailableBehaviour](https://chart.syidax.com/docs/types/WaterfallUnavailableBehaviour.md) — Type definition

<a id="events"></a>

## Events

<a id="event-rendered"></a>

### 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 }>`.

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

- [WaterfallRenderResult](https://chart.syidax.com/docs/types/WaterfallRenderResult.md) — Type definition
- [WaterfallEngineTier](https://chart.syidax.com/docs/types/WaterfallEngineTier.md) — Type definition
- [ChartEngineStatus](https://chart.syidax.com/docs/types/ChartEngineStatus.md) — Type definition

<a id="event-pointClick"></a>

### 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>`.

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

- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="event-pointHover"></a>

### 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>`.

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

- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="event-crosshairMove"></a>

### 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>`.

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

- [CartesianCrosshairEventDetail](https://chart.syidax.com/docs/types/CartesianCrosshairEventDetail.md) — Type definition

<a id="event-pointContextMenu"></a>

### 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>>`.

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="event-appended"></a>

### 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 }>`.

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

<a id="event-windowSlid"></a>

### 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 }>`.

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

<a id="event-tooltipShow"></a>

### tooltipShow

The shared tooltip events (the controller emits them).

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

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

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="event-tooltipHide"></a>

### 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>`.

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

<a id="event-tooltipAction"></a>

### 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>`.

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

- [CartesianTooltipActionEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipActionEventDetail.md) — Type definition

<a id="event-chartAnimationStart"></a>

### 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>`.

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

<a id="event-chartAnimationEnd"></a>

### 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>`.

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

<a id="event-chartAnimationInterrupted"></a>

### 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>`.

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

<a id="event-zoomChange"></a>

### 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>`.

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="methods"></a>

## Methods

<a id="method-getDataTable"></a>

### getDataTable

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

```typescript
getDataTable(): Promise<ChartDataTable>
```

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

- [ChartDataTable](https://chart.syidax.com/docs/types/ChartDataTable.md) — Type definition

<a id="method-redraw"></a>

### redraw

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

```typescript
redraw(): Promise<WaterfallRenderResult>
```

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

- [WaterfallRenderResult](https://chart.syidax.com/docs/types/WaterfallRenderResult.md) — Type definition

<a id="method-getActiveTier"></a>

### getActiveTier

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

```typescript
getActiveTier(): Promise<WaterfallEngineTier>
```

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

- [WaterfallEngineTier](https://chart.syidax.com/docs/types/WaterfallEngineTier.md) — Type definition

<a id="method-getUnavailableReason"></a>

### getUnavailableReason

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

```typescript
getUnavailableReason(): Promise<string | undefined>
```

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

<a id="method-setData"></a>

### setData

Replace the bar set.

```typescript
setData(data: WaterfallData): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `WaterfallData` | Required |

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

- [WaterfallData](https://chart.syidax.com/docs/types/WaterfallData.md) — Type definition

<a id="method-appendPoint"></a>

### appendPoint

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

```typescript
appendPoint(datum: WaterfallDatumInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `datum` | `WaterfallDatumInput` | Required |

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

- [WaterfallDatumInput](https://chart.syidax.com/docs/types/WaterfallDatumInput.md) — Type definition

<a id="method-appendBatch"></a>

### appendBatch

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ReadonlyArray<WaterfallDatumInput>` | Required |

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

- [WaterfallDatumInput](https://chart.syidax.com/docs/types/WaterfallDatumInput.md) — Type definition

<a id="method-shift"></a>

### shift

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

```typescript
shift(count: number): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `count` | `number` | Required |

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

<a id="method-replace"></a>

### 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).

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ReadonlyArray<WaterfallDatumInput>` | Required |

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

- [WaterfallDatumInput](https://chart.syidax.com/docs/types/WaterfallDatumInput.md) — Type definition

<a id="method-getStreamSource"></a>

### getStreamSource

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

```typescript
getStreamSource(): Promise<WaterfallStreamSource | undefined>
```

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

- [WaterfallStreamSource](https://chart.syidax.com/docs/types/WaterfallStreamSource.md) — Type definition

<a id="method-setAnimation"></a>

### setAnimation

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `{ duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType }` | Required |

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

- [WaterfallEasing](https://chart.syidax.com/docs/types/WaterfallEasing.md) — Type definition
- [WaterfallAnimationType](https://chart.syidax.com/docs/types/WaterfallAnimationType.md) — Type definition

<a id="method-pauseAnimation"></a>

### pauseAnimation

Pause the current animation.

```typescript
pauseAnimation(): Promise<void>
```

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

<a id="method-resumeAnimation"></a>

### resumeAnimation

Resume a paused animation.

```typescript
resumeAnimation(): Promise<void>
```

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

<a id="method-replayAnimation"></a>

### replayAnimation

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

```typescript
replayAnimation(): Promise<void>
```

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

<a id="method-hitTest"></a>

### hitTest

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `cssX` | `number` | Required |
| `cssY` | `number` | Required |

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

- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="method-getBar"></a>

### getBar

The normalised bar at an index (null outside).

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

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

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

- [WaterfallBar](https://chart.syidax.com/docs/types/WaterfallBar.md) — Type definition

<a id="method-getBarByCategory"></a>

### getBarByCategory

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `category` | `string` | Required |

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

- [WaterfallBar](https://chart.syidax.com/docs/types/WaterfallBar.md) — Type definition

<a id="method-getBarCount"></a>

### getBarCount

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

```typescript
getBarCount(): Promise<number>
```

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

<a id="method-getBars"></a>

### getBars

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

```typescript
getBars(): Promise<WaterfallBar[]>
```

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

- [WaterfallBar](https://chart.syidax.com/docs/types/WaterfallBar.md) — Type definition

<a id="method-getCategories"></a>

### getCategories

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

```typescript
getCategories(): Promise<string[]>
```

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

<a id="method-getExtent"></a>

### getExtent

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

```typescript
getExtent(): Promise<WaterfallExtent>
```

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

- [WaterfallExtent](https://chart.syidax.com/docs/types/WaterfallExtent.md) — Type definition

<a id="method-getDomain"></a>

### getDomain

The data domain the grid spans.

```typescript
getDomain(): Promise<WaterfallDomain>
```

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

- [WaterfallDomain](https://chart.syidax.com/docs/types/WaterfallDomain.md) — Type definition

<a id="method-getRunningTotal"></a>

### getRunningTotal

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

```typescript
getRunningTotal(): Promise<number>
```

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

<a id="method-showTooltipAtIndex"></a>

### showTooltipAtIndex

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

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

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-hideTooltip"></a>

### hideTooltip

Close the currently visible tooltip.

```typescript
hideTooltip(): Promise<void>
```

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

<a id="method-focusBarAt"></a>

### focusBarAt

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

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

- [WaterfallPointEventDetail](https://chart.syidax.com/docs/types/WaterfallPointEventDetail.md) — Type definition

<a id="method-zoomTo"></a>

### 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).

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

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomRequest` | Required |

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition
- [CartesianZoomRequest](https://chart.syidax.com/docs/types/CartesianZoomRequest.md) — Type definition

<a id="method-zoomBy"></a>

### zoomBy

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `factor` | `number` | Required |
| `anchorFraction` | `number` | Optional |

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-panBy"></a>

### panBy

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `delta` | `{ x?: number; y?: number }` | Required |

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-resetZoom"></a>

### resetZoom

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

```typescript
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>
```

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-getZoom"></a>

### getZoom

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

```typescript
getZoom(): Promise<CartesianZoomState | null>
```

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

- [CartesianZoomState](https://chart.syidax.com/docs/types/CartesianZoomState.md) — Type definition

<a id="method-getZoomExtent"></a>

### getZoomExtent

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomExtentRequest` | Optional |

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

- [CartesianZoomExtentDetail](https://chart.syidax.com/docs/types/CartesianZoomExtentDetail.md) — Type definition
- [CartesianZoomExtentRequest](https://chart.syidax.com/docs/types/CartesianZoomExtentRequest.md) — Type definition

<a id="method-getEngineStatus"></a>

### 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.

```typescript
getEngineStatus(): Promise<ChartEngineStatus>
```

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

- [ChartEngineStatus](https://chart.syidax.com/docs/types/ChartEngineStatus.md) — Type definition