Waterfall.

PRO

Show how increases and decreases accumulate into a final value.

<sy-waterfall-chart>Installation and integration API reference

LIVE EXAMPLE

Revenue changes

Match the page theme

Interact with the chart to see selection and range-change results here.

Add increases and decreases to the opening value to show the final total. All values are sample data.

View code

Current preview

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

Usage and data

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.

Data contract

Property	Input format
`data`	An array of { category, value?, kind? }. kind is delta, subtotal, or total.

Updating data

Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.

Feature examples

Try 20 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.