Theme River

data

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

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

• ThemeRiverData

  Type definition

width

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

height

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

brandLogo

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

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

brandPosition

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

offset

The baseline mode: silhouette, zero, or expand.

• ThemeRiverOffset

  Type definition

order

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

• ThemeRiverOrder

  Type definition

colors

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

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

opacity

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

axes

Pass as a JavaScript property. type: ThemeRiverAxesOptions.

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

• ThemeRiverAxesOptions

  Type definition

legend

Whether to show a legend for series or items.

hiddenSeries

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

• ThemeRiverId

  Type definition

chartTitle

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

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

chartSubtitle

The subtitle inside the chart.

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

locale

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

showEmpty

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

activeColor

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

enableMouseTracking

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

tooltip

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

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

• CartesianTooltipInput

  Type definition

tooltipEnabled

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

tooltipFormat

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

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

• ThemeRiverHitDetail

  Type definition

zoom

Settings for zooming and the visible range.

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

• CartesianZoomInput

  Type definition

crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

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

• CartesianCrosshairInput

  Type definition

crosshairSnapDistance

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

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

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

• ThemeRiverEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

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

• ThemeRiverAnimationType

  Type definition

streamSource

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

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

• ThemeRiverStreamSource

  Type definition

streamMax

The maximum number of streaming data points to retain.

streamWindow

The streaming data range to keep visible.

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

engine

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

• ThemeRiverEngineMode

  Type definition

unavailable

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

• ThemeRiverUnavailableBehaviour

  Type definition

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

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

• ThemeRiverRenderResult

  Type definition

• ThemeRiverEngineTier

  Type definition

pointClick

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

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

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

• ThemeRiverHitDetail

  Type definition

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

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

• ThemeRiverHitDetail

  Type definition

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

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

• ThemeRiverSelectionChangeEventDetail

  Type definition

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

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

• ThemeRiverCrosshairDetail

  Type definition

appended

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

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

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

windowSlid

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

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

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

chartAnimationStart

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

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

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

chartAnimationEnd

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

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

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

chartAnimationInterrupted

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

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

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

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

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

tooltipShow

Whether to display the built-in tooltip.

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

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

• CartesianTooltipEventDetail

  Type definition

tooltipHide

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

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

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

tooltipAction

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

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

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

• CartesianTooltipActionEventDetail

  Type definition

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

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

• CartesianZoomChangeEventDetail

  Type definition

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

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

• ChartPointContextMenuEventDetail

  Type definition

• ThemeRiverHitDetail

  Type definition

redraw

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

redraw(): Promise<ThemeRiverRenderResult>

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

• ThemeRiverRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<HeatmapEngineTier>

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

• HeatmapEngineTier

  Type definition

getUnavailableReason

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

getUnavailableReason(): Promise<string>

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

getEngineStatus

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

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  Type definition

recycleGpu

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

recycleGpu(): Promise<void>

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

setData

Replace the bar set.

setData(data: ThemeRiverData): Promise<void>

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

• ThemeRiverData

  Type definition

getData

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

getData(): Promise<ThemeRiverData>

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

• ThemeRiverData

  Type definition

getLayout

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

getLayout(): Promise<ThemeRiverLayout>

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

• ThemeRiverLayout

  Type definition

getDiagnostics

Normalization diagnostics for the effective base and stream source.

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.

appendPoint

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

appendPoint(row: ThemeRiverRow): Promise<void>

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

• ThemeRiverRow

  Type definition

appendBatch

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

appendBatch(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>

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

• ThemeRiverRow

  Type definition

replace

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

replace(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>

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

• ThemeRiverRow

  Type definition

shift

Drop the oldest streamed categories (the data boxes are not the stream).

shift(count: number): Promise<void>

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

getStreamSource

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

getStreamSource(): Promise<ThemeRiverStreamSource>

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

• ThemeRiverStreamSource

  Type definition

clearStream

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

clearStream(): Promise<void>

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

setAnimation

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

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

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

• ThemeRiverEasing

  Type definition

• ThemeRiverAnimationType

  Type definition

pauseAnimation

Pause the current animation.

pauseAnimation(): Promise<void>

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

resumeAnimation

Resume a paused animation.

resumeAnimation(): Promise<void>

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

replayAnimation

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

replayAnimation(): Promise<void>

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

getDataTable

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

getDataTable(): Promise<ChartDataTable>

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

• ChartDataTable

  Type definition

getCSV

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

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

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

• CsvOptions

  Type definition

getTable

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

getTable(): Promise<string>

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

hitTest

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

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

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

  Type definition

selectPointAt

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

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

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

  Type definition

clearSelection

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

clearSelection(): Promise<void>

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

getSelection

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

getSelection(): Promise<ThemeRiverSelection | null>

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

• ThemeRiverSelection

  Type definition

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.

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

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

• CartesianTooltipEventDetail

  Type definition

showTooltipAtIndex

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

showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail>

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

• CartesianTooltipEventDetail

  Type definition

hideTooltip

Close the currently visible tooltip.

hideTooltip(): Promise<void>

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

showCrosshairAt

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

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

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

showCrosshairAtData

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

showCrosshairAtData(request: CartesianCrosshairShowRequest): Promise<boolean>

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

• CartesianCrosshairShowRequest

  Type definition

hideCrosshair

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

hideCrosshair(): Promise<void>

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

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

zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail>

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

• CartesianZoomChangeEventDetail

  Type definition

• CartesianZoomRequest

  Type definition

zoomBy

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

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

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

• CartesianZoomChangeEventDetail

  Type definition

panBy

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

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

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

• CartesianZoomChangeEventDetail

  Type definition

resetZoom

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

resetZoom(): Promise<CartesianZoomChangeEventDetail>

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

• CartesianZoomChangeEventDetail

  Type definition

getZoom

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

getZoom(): Promise<CartesianZoomState>

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

• CartesianZoomState

  Type definition

getZoomExtent

the full extent (and key) of the primary — or the named — master axes (null before the first layout).

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

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

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition