Heatmap

data

An array of { x, y, value }. x and y are numeric or categorical coordinates.

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

• HeatmapData

  Type definition

matrix

A dense matrix: { columns, rows, values } (row-major) or rows of columns.

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

• HeatmapMatrixInput

  Type definition

xCategories

Column labels (array, or a comma list attribute). Given explicitly, they fix the column count.

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

• HeatmapCategoriesInput

  Type definition

yCategories

Row labels (row 0 is the top row).

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

• HeatmapCategoriesInput

  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.

colors

The colour ramp: a scheme name (viridis, blues, …), a colour list / comma list, or [t, colour] stops.

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

• HeatmapColorInput

  Type definition

valueMin

Domain ends; an omitted end follows the data extent.

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

valueMax

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

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

emptyColor

The colour of an empty cell (default transparent — the host background shows).

cellGap

Gap between cells in CSS px.

renderPath

the draw path: auto (the cells path from 3 device px per cell, else the plane), or a forced plane / cells.

• HeatmapRenderPath

  Type definition

cellRadius

cell corner radius in CSS px (the cells path).

cellBorder

cell border width in CSS px (the cells path).

cellBorderColor

cell border colour.

lod

the plane path's level of detail: auto (area-averaged once a cell is under a device px), point, area.

• HeatmapLodMode

  Type definition

areaReduce

how the area LOD folds the cells a pixel covers: mean (default) or max (peak-hold).

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.

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

• CartesianAxisInput

  Type definition

yAxis

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

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

• YAxisInput

  Type definition

gridLines

Grid lines default OFF (the cells tile the plot).

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

• CartesianGridLinesInput

  Type definition

crosshair

Crosshair that follows the cursor across the plot.

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

• CartesianCrosshairInput

  Type definition

zoom

Zoom (2026-09-10) — the shared cartesian zoom on the column / row indexes: a mode ('x' | 'y' | 'xy'), true, 'inside' or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default.

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

• CartesianZoomInput

  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.

enableMouseTracking

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

tooltip

the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …).

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

a plain-text formatter of the default tooltip (tooltip.format wins).

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

• HeatmapPointEventDetail

  Type definition

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

• HeatmapEasing

  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.

• HeatmapAnimationType

  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.

• HeatmapStreamSource

  Type definition

streamMax

Cells the internal stream source tracks at most (oldest cells empty first).

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

streamWindow

The newest N streamed upserts the chart renders (the whole buffer when unset); older tracked cells revert to the base plane.

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

visualMap

a visual-map binding (a sy-visual-map snapshot + dimension); it overrides colors / value-min / value-max while bound.

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

• VisualMapBinding

  Type definition

engine

auto, standard and pro all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down.

• HeatmapEngineMode

  Type definition

unavailable

fallback shows the on-chart notice when the renderer cannot run; error throws.

• HeatmapUnavailableBehaviour

  Type definition

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<HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }>.

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

• HeatmapRenderResult

  Type definition

• HeatmapEngineTier

  Type definition

• ChartEngineStatus

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

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

• HeatmapPointEventDetail

  Type definition

pointHover

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

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

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

• HeatmapPointEventDetail

  Type definition

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

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

• CartesianCrosshairEventDetail

  Type definition

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  Type definition

• HeatmapPointEventDetail

  Type definition

appended

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

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

chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: 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
});

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

Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); null zoom = the full extent.

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

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

redraw

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

redraw(): Promise<HeatmapRenderResult>

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

• HeatmapRenderResult

  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

The reason the renderer cannot run (undefined while it runs).

getUnavailableReason(): Promise<string | undefined>

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

setData

Replace the bar set.

setData(data: HeatmapData): Promise<void>

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

• HeatmapData

  Type definition

setMatrix

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

setMatrix(matrix: HeatmapMatrixInput): Promise<void>

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

• HeatmapMatrixInput

  Type definition

appendPoint

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

appendPoint(cell: HeatmapDatum | HeatmapTuple): Promise<void>

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

• HeatmapDatum

  Type definition

• HeatmapTuple

  Type definition

appendBatch

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

appendBatch(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>

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

• HeatmapDatum

  Type definition

• HeatmapTuple

  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.

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(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>

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

• HeatmapDatum

  Type definition

• HeatmapTuple

  Type definition

getStreamSource

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

getStreamSource(): Promise<HeatmapStreamSource | undefined>

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

• HeatmapStreamSource

  Type definition

setAnimation

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

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

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

• HeatmapEasing

  Type definition

• HeatmapAnimationType

  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.

showTooltipAtCell

open the tooltip on a cell (col / row), honouring the tooltip input; null when the tooltip is off or the cell is outside.

showTooltipAtCell(col: number, row: number): Promise<CartesianTooltipEventDetail | null>

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

• CartesianTooltipEventDetail

  Type definition

showTooltipAtIndex

open the tooltip on a cell by its index (row * columns + col; the facade's showTooltipAtPoint).

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

Return type: Promise<CartesianTooltipEventDetail | null>. 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.

focusCellAt

move the keyboard focus to a cell (the arrow-key state); null clears it.

focusCellAt(col: number, row: number): Promise<HeatmapPointEventDetail | null>

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

• HeatmapPointEventDetail

  Type definition

hitTest

The cell under host-relative CSS coordinates (inside the plot, through the zoomed matrix), or null.

hitTest(cssX: number, cssY: number): Promise<HeatmapPointEventDetail | null>

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

• HeatmapPointEventDetail

  Type definition

getCellValue

The value of a cell (null when empty or outside the grid).

getCellValue(col: number, row: number): Promise<number | null>

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

getValueExtent

Min / max / finite count of the current values (null when nothing is finite).

getValueExtent(): Promise<HeatmapValueExtent | null>

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

• HeatmapValueExtent

  Type definition

getGridSize

Columns × rows of the current grid.

getGridSize(): Promise<{ columns: number; rows: number; cells: number }>

Return type: Promise<{ columns: number; rows: number; cells: number }>. Call the method after element registration and await its Promise result.

zoomTo

Zoom to explicit windows in index units: x / y as { min, max } or [min, max] (null clears that orientation).

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

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

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

• CartesianZoomChangeEventDetail

  Type definition

panBy

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

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

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

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

Return type: Promise<CartesianZoomState | null>. 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 — axes: -0.5 … columns - 0.5 / -0.5 … rows - 0.5.

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

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

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition

setVisualMap

Bind (or clear) a visual map: every cell is coloured through it on the next frame.

setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>

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

• VisualMapBinding

  Type definition

getVisualMap

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

getVisualMap(): Promise<VisualMapBinding | null>

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

• VisualMapBinding

  Type definition

getVisualExtent

The extent a bound sy-visual-map adopts as its domain: the finite cell values (value), or the index ranges (x = columns, y = rows, index = cells).

getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>

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

• VisualMapExtent

  Type definition

• VisualMapExtentRequest

  Type definition

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.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  Type definition