# Theme River

Stack multiple flows as they change over time.

Canonical: https://chart.syidax.com/docs/components/theme-river/

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

## sy-theme-river

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.

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

| Input | Data description |
| --- | --- |
| `data` | { x: [...], series: [{ id, name?, values }] }. Align every values array with x. |
| `offset` | The baseline mode: silhouette, zero, or expand. |

- [Run in Components](https://chart.syidax.com/charts/theme-river) — 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-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>
```

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

## Properties

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

### data

{ x: [...], series: [{ id, name?, values }] }. Align every values array with x.

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

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

- [ThemeRiverData](https://chart.syidax.com/docs/types/ThemeRiverData.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 | `420` |

<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-offset"></a>

### offset

The baseline mode: silhouette, zero, or expand.

| Item | Value |
| --- | --- |
| JavaScript property | `offset` |
| HTML attribute | `offset` |
| Type | `ThemeRiverOffset` |
| Default | `'silhouette'` |
| Allowed values | `silhouette`, `zero`, `expand` |

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

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

### order

Allowed values: input, reverse. Default: 'input'.

| Item | Value |
| --- | --- |
| JavaScript property | `order` |
| HTML attribute | `order` |
| Type | `ThemeRiverOrder` |
| Default | `'input'` |
| Allowed values | `input`, `reverse` |

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

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

### colors

Pass as a JavaScript property. type: ReadonlyArray<string>.

| Item | Value |
| --- | --- |
| JavaScript property | `colors` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ReadonlyArray<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-opacity"></a>

### opacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `opacity` |
| HTML attribute | `opacity` |
| Type | `number` |
| Default | `1` |

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

### axes

Pass as a JavaScript property. type: ThemeRiverAxesOptions.

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

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

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

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

### legend

Whether to show a legend for series or items.

| Item | Value |
| --- | --- |
| JavaScript property | `legend` |
| HTML attribute | `legend` |
| Type | `boolean` |
| Default | `true` |

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

### hiddenSeries

Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>.

| Item | Value |
| --- | --- |
| JavaScript property | `hiddenSeries` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ReadonlyArray<ThemeRiverId>` |
| Default | `[]` |

- [ThemeRiverId](https://chart.syidax.com/docs/types/ThemeRiverId.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-locale"></a>

### locale

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

| Item | Value |
| --- | --- |
| JavaScript property | `locale` |
| HTML attribute | `locale` |
| Type | `string` |
| Default | `'en'` |

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

### showEmpty

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

| Item | Value |
| --- | --- |
| JavaScript property | `showEmpty` |
| HTML attribute | `show-empty` |
| Type | `boolean` |
| Default | `true` |

<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 | `'#f59e0b'` |

<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

Tooltip settings for pointer-driven values, position, and content.

| 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: ThemeRiverHitDetail) => string.

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

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

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

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

### zoom

Settings for zooming and the visible range.

| 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-crosshair"></a>

### crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

| 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-crosshairSnapDistance"></a>

### crosshairSnapDistance

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

| Item | Value |
| --- | --- |
| JavaScript property | `crosshairSnapDistance` |
| HTML attribute | `crosshair-snap-distance` |
| Type | `number` |
| Default | `24` |

<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 | `ThemeRiverEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [ThemeRiverEasing](https://chart.syidax.com/docs/types/ThemeRiverEasing.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 | `ThemeRiverAnimationType` |
| 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.

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

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

### streamSource

A stream source for live data. Check the contract for the specific type.

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

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

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

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

### streamMax

The maximum number of streaming data points to retain.

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

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

### streamWindow

The streaming data range to keep visible.

| 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 | `ThemeRiverEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

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

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

### unavailable

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

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

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

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

## Events

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

### rendered

Emits rendering results in detail when chart drawing completes.

Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverRenderResult & {
        tier: ThemeRiverEngineTier;
    }>`.

```javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // ThemeRiverRenderResult & {
        tier: ThemeRiverEngineTier;
    }
});
```

- [ThemeRiverRenderResult](https://chart.syidax.com/docs/types/ThemeRiverRenderResult.md) — Type definition
- [ThemeRiverEngineTier](https://chart.syidax.com/docs/types/ThemeRiverEngineTier.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<ThemeRiverHitDetail>`.

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

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

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

### pointHover

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

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

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

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

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

### selectionChanged

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

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

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

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

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

### crosshairMove

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

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

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

- [ThemeRiverCrosshairDetail](https://chart.syidax.com/docs/types/ThemeRiverCrosshairDetail.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-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-dataValidationError"></a>

### dataValidationError

CustomEvent.detail type: {
        message: string;
    }. Event names are case-sensitive.

Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{
        message: string;
    }>`.

```javascript
chart.addEventListener('dataValidationError', event => {
  console.log(event.detail); // {
        message: string;
    }
});
```

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

### tooltipShow

Whether to display the built-in tooltip.

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-zoomChange"></a>

### zoomChange

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

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="event-pointContextMenu"></a>

### pointContextMenu

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

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

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

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

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

## Methods

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

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

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

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

### getActiveTier

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

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

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

- [HeatmapEngineTier](https://chart.syidax.com/docs/types/HeatmapEngineTier.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>
```

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

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

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.

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

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

### recycleGpu

Without the grant (or while frozen) nothing is recycled: no GPU work starts.

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ThemeRiverData` | Required |

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

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

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

### getData

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

```typescript
getData(): Promise<ThemeRiverData>
```

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

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

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

### getLayout

Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.

```typescript
getLayout(): Promise<ThemeRiverLayout>
```

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

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

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

### getDiagnostics

Normalization diagnostics for the effective base and stream source.

```typescript
getDiagnostics(): Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>
```

Return type: `Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>`. Call the method after element registration and await its Promise result.

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

### appendPoint

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

```typescript
appendPoint(row: ThemeRiverRow): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `row` | `ThemeRiverRow` | Required |

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

- [ThemeRiverRow](https://chart.syidax.com/docs/types/ThemeRiverRow.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(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `rows` | `ReadonlyArray<ThemeRiverRow>` | Required |

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

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

<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(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `rows` | `ReadonlyArray<ThemeRiverRow>` | Required |

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

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

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

### shift

Drop the oldest streamed categories (the `data` boxes 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-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<ThemeRiverStreamSource>
```

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

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

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

### clearStream

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

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

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

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

### setAnimation

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `{<br>        enabled?: boolean;<br>        duration?: number;<br>        easing?: ThemeRiverEasing;<br>        type?: ThemeRiverAnimationType;<br>    }` | Required |

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

- [ThemeRiverEasing](https://chart.syidax.com/docs/types/ThemeRiverEasing.md) — Type definition
- [ThemeRiverAnimationType](https://chart.syidax.com/docs/types/ThemeRiverAnimationType.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-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-getCSV"></a>

### getCSV

The tape as a CSV table (ISO time, OHLC, volume).

```typescript
getCSV(options?: CsvOptions): Promise<string>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `CsvOptions` | Optional |

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

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

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

### getTable

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

```typescript
getTable(): Promise<string>
```

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

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

### hitTest

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

```typescript
hitTest(cssX: number, cssY: number): Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>
```

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

Return type: `Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. Call the method after element registration and await its Promise result.

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

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

### selectPointAt

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

```typescript
selectPointAt(series: number, column: number): Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `series` | `number` | Required |
| `column` | `number` | Required |

Return type: `Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. Call the method after element registration and await its Promise result.

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

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

### clearSelection

Release the selection (emits selectionChanged when there was one).

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

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

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

### getSelection

The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license.

```typescript
getSelection(): Promise<ThemeRiverSelection | null>
```

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

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

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

### showTooltipAtPoint

Open the tooltip for a dot programmatically. `pointIndex` is the category (row) index; the optional `seriesIndex` selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled.

```typescript
showTooltipAtPoint(series: number, column: number): Promise<CartesianTooltipEventDetail>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `series` | `number` | Required |
| `column` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail>`. 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-showTooltipAtIndex"></a>

### showTooltipAtIndex

open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off.

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

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

Return type: `Promise<CartesianTooltipEventDetail>`. 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-showCrosshairAt"></a>

### showCrosshairAt

show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot.

```typescript
showCrosshairAt(series: number, column: number): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `series` | `number` | Required |
| `column` | `number` | Required |

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

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

### showCrosshairAtData

Quiet source-category synchronization. Categories retain their original string or number type.

```typescript
showCrosshairAtData(request: CartesianCrosshairShowRequest): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianCrosshairShowRequest` | Required |

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

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

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

### hideCrosshair

hide the crosshair shown by `showCrosshairAt` (or the pointer's).

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

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

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

### zoomTo

zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis).

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

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

Return type: `Promise<CartesianZoomChangeEventDetail>`. 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>
```

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

Return type: `Promise<CartesianZoomChangeEventDetail>`. 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? }`); a no-op at the full extent.

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

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

Return type: `Promise<CartesianZoomChangeEventDetail>`. 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>
```

Return type: `Promise<CartesianZoomChangeEventDetail>`. 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>
```

Return type: `Promise<CartesianZoomState>`. 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 (`null` before the first layout).

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

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

Return type: `Promise<CartesianZoomExtentDetail>`. 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