Theme River.

PRO

Stack multiple flows as they change over time.

Live preview38 feature examples

LIVE EXAMPLE

Composition over time

Match the page theme
Interact with the chart to see selection and range-change results here.
OptionsChanges are reflected in the preview and code.
Appearance and style3
Legend and interaction14
Title and dimensions3

Stack series around a centerline to show their flow. 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-theme-river.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-theme-river",
      "props": {
        "data": {
          "x": [0, 1, 2, 3, 4, 5],
          "series": [
            {
              "id": "s0",
              "name": "Online",
              "values": [24, 29, 27, 38, 43, 40],
              "color": "#8263d9"
            },
            {
              "id": "s1",
              "name": "Store",
              "values": [15, 19, 17, 24, 22, 29],
              "color": "#239c91"
            }
          ]
        },
        "offset": "silhouette",
        "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', 'theme-river 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

#

Explore changes in topic interest or composition.

The central baseline moves, so read band thickness rather than vertical position. Use a table for precise comparisons.

Data contract

PropertyInput format
data{ x: [...], series: [{ id, name?, values }] }. Align every values array with x.
offsetThe baseline mode: silhouette, zero, or expand.

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.

Add to your interface

#

The code tabs below the preview contain the full data, options, event bindings, and responsive sizing for the current example. Copy them into an app project, such as Vite, that can resolve the installed packages.

Shared sy-chart API versus direct tags

API reference

#

The full public API for sy-theme-river. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
ThemeRiverDataDefault: undefined{ x: [...], series: [{ id, name?, values }] }. Align every values array with x.
numberDefault: 900Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 420Chart height in pixels.
brandLogostringDefault: undefinedThe default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL.
brandPosition'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right'The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports.
ThemeRiverOffsetDefault: 'silhouette'The baseline mode: silhouette, zero, or expand.
ThemeRiverOrderDefault: 'input'Allowed values: input, reverse. Default: 'input'.
numberDefault: 1Set as an HTML attribute or JavaScript property. type: number.
booleanDefault: trueWhether to show a legend for series or items.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
CartesianTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
tooltipEnabledbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
CartesianCrosshairInputDefault: undefinedPass as a JavaScript property. type: CartesianCrosshairInput.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingThemeRiverEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeThemeRiverAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 14
Attribute / PropertyType / DefaultDescription
ReadonlyArray<string>Default: undefinedPass as a JavaScript property. type: ReadonlyArray<string>.
ThemeRiverAxesOptionsDefault: undefinedPass as a JavaScript property. type: ThemeRiverAxesOptions.
hiddenSeriesReadonlyArray<ThemeRiverId>Default: []Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>.
stringDefault: 'en'Set as an HTML attribute or JavaScript property. type: string.
showEmptybooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
activeColorstringDefault: '#f59e0b'Set as an HTML attribute or JavaScript property. type: string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
tooltipFormat(detail: ThemeRiverHitDetail) => stringDefault: undefinedPass as a JavaScript property. type: (detail: ThemeRiverHitDetail) => string.
crosshairSnapDistancenumberDefault: 24Set as an HTML attribute or JavaScript property. type: number.
streamSourceThemeRiverStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamMaxnumberDefault: 128The maximum number of streaming data points to retain.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
ThemeRiverEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
ThemeRiverUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error. Default: 'fallback'.
Events 16
EventsDetail typeDescription
ThemeRiverRenderResult & { tier: ThemeRiverEngineTier; }Emits rendering results in detail when chart drawing completes.
ThemeRiverHitDetailA point selection event. Read the selected data and index from CustomEvent.detail.
ThemeRiverHitDetail | nullCustomEvent.detail type: ThemeRiverHitDetail | null. Event names are case-sensitive.
ThemeRiverSelectionChangeEventDetailCustomEvent.detail type: ThemeRiverSelectionChangeEventDetail. Event names are case-sensitive.
ThemeRiverCrosshairDetail | nullCustomEvent.detail type: ThemeRiverCrosshairDetail | null. Event names are case-sensitive.
{ count: number; replaced: number; }CustomEvent.detail type: { count: number; replaced: number; }. Event names are case-sensitive.
{ dropped: number; }CustomEvent.detail type: { dropped: number; }. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
{ message: string; }CustomEvent.detail type: { message: string; }. Event names are case-sensitive.
CartesianTooltipEventDetailWhether to display the built-in tooltip.
voidCustomEvent.detail type: void. Event names are case-sensitive.
CartesianTooltipActionEventDetailCustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.
CartesianZoomChangeEventDetailCustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive.
ChartPointContextMenuEventDetail<ThemeRiverHitDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<ThemeRiverHitDetail>. Event names are case-sensitive.
Methods 38

Stencil methods return Promises. Use await within an async function to read the result.

Method / ArgumentsReturn typeDescription
Promise<ThemeRiverRenderResult>An asynchronous method. Check the argument and return types below.
Promise<HeatmapEngineTier>An asynchronous method. Check the argument and return types below.
Promise<string>An asynchronous method. Check the argument and return types below.
Promise<ChartEngineStatus>Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.
Promise<void>Without the grant (or while frozen) nothing is recycled: no GPU work starts.
data: ThemeRiverDataPromise<void>An asynchronous method. Check the argument and return types below.
Promise<ThemeRiverData>An asynchronous method. Check the argument and return types below.
Promise<ThemeRiverLayout>An asynchronous method. Check the argument and return types below.
Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>An asynchronous method. Check the argument and return types below.
row: ThemeRiverRowPromise<void>An asynchronous method. Check the argument and return types below.
rows: ReadonlyArray<ThemeRiverRow>Promise<void>An asynchronous method. Check the argument and return types below.
rows: ReadonlyArray<ThemeRiverRow>Promise<void>An asynchronous method. Check the argument and return types below.
count: numberPromise<void>An asynchronous method. Check the argument and return types below.
Promise<ThemeRiverStreamSource>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
options: { enabled?: boolean; duration?: number; easing?: ThemeRiverEasing; type?: ThemeRiverAnimationType; }Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<ChartDataTable>An asynchronous method. Check the argument and return types below.
options?: CsvOptionsPromise<string>An asynchronous method. Check the argument and return types below.
Promise<string>An asynchronous method. Check the argument and return types below.
cssX: number, cssY: numberPromise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>An asynchronous method. Check the argument and return types below.
series: number, column: numberPromise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<ThemeRiverSelection | null>An asynchronous method. Check the argument and return types below.
series: number, column: numberPromise<CartesianTooltipEventDetail>An asynchronous method. Check the argument and return types below.
index: numberPromise<CartesianTooltipEventDetail>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
series: number, column: numberPromise<boolean>An asynchronous method. Check the argument and return types below.
request: CartesianCrosshairShowRequestPromise<boolean>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
request: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail>An asynchronous method. Check the argument and return types below.
factor: number, anchorFraction?: numberPromise<CartesianZoomChangeEventDetail>An asynchronous method. Check the argument and return types below.
delta: { x?: number; y?: number; }Promise<CartesianZoomChangeEventDetail>An asynchronous method. Check the argument and return types below.
Promise<CartesianZoomChangeEventDetail>An asynchronous method. Check the argument and return types below.
Promise<CartesianZoomState>An asynchronous method. Check the argument and return types below.
request?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail>An asynchronous method. Check the argument and return types below.