Item

values

An array of { name, value, color? }. value is the symbol count.

• ItemChartValues

  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.

palette

Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'.

• ItemChartPaletteName

  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.

symbol

circle, square, or diamond.

• ItemChartSymbol

  Type definition

rows

Explicit concentric ring count; auto (smallest that fits) when unset.

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

itemPadding

0..0.9 — fraction of each cell kept as whitespace around its dot (Highcharts itemPadding).

startAngle

Degrees, 0 = 12 o'clock, clockwise. Default −100…100 = parliament hemicycle.

endAngle

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

innerSize

Central hole — px or % of the outer radius (Highcharts innerSize).

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

size

Pass as a JavaScript property. type: number | string.

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

centerX

Pass as a JavaScript property. type: number | string.

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

centerY

Pass as a JavaScript property. type: number | string.

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

minSize

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

centerText

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

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

centerSubtext

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

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

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.

legend

Whether to show a legend for series or items.

legendPosition

Edge to dock the legend on, or float — an overlay inside the seats' drawing rectangle (Storybook parity, 2026-09-10).

• ItemChartLegendPosition

  Type definition

legendItems

Pass as a JavaScript property. type: LegendItem[].

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

• LegendItem

  Type definition

legendFloatAlign

legend-position="float": the overlay's horizontal anchor inside the drawing rectangle.

legendFloatVerticalAlign

legend-position="float": the overlay's vertical anchor inside the drawing rectangle.

legendDraggable

legend-position="float": the floating legend can be dragged inside the chart bounds.

tooltipShow

Whether to display the built-in tooltip.

tooltipFormat

Pass as a JavaScript property. type: (party: ItemChartResolvedParty) => string.

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

• ItemChartResolvedParty

  Type definition

tooltip

Rich tooltip configuration object — the party-flavoured counterpart of the pie .tooltip API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat tooltip-show / tooltipFormat props. Property-only.

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

• ItemChartTooltipInput

  Type definition

enableMouseTracking

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

zoom

Zoom (Storybook parity, 2026-09-10) — the shared zoom surface as a VIEWPORT zoom: the seats' drawing rectangle (the chart box minus the title and legend bands) is the plot, x 0 → 1 left to right and y 0 → 1 bottom to top. 'x' | 'y' | 'xy' | true (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (+ / - / Escape); an object refines the switches. Off by default; zoomTo / zoomBy / panBy / resetZoom work regardless.

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

• CartesianZoomInput

  Type definition

engine

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

• ItemChartEngineMode

  Type definition

unavailable

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

• ItemChartUnavailableBehaviour

  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.

• ItemChartStreamSource

  Type definition

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.

streamMax

The maximum number of streaming data points to retain.

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

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

• ItemChartEasing

  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.

• ItemChartAnimationType

  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<ItemChartRenderResult & { tier: ItemChartEngineTier }>.

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

• ItemChartRenderResult

  Type definition

• ItemChartEngineTier

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

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

• ItemChartPointEventDetail

  Type definition

pointHover

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

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

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

• ItemChartPointEventDetail

  Type definition

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  Type definition

• ItemChartPointEventDetail

  Type definition

legendItemClick

CustomEvent.detail type: { index: number; partyId: string; label: string; disabled: boolean }. Event names are case-sensitive.

Event name: legendItemClick. Names are case-sensitive. Read the payload from detail on CustomEvent<{ index: number; partyId: string; label: string; disabled: boolean }>.

chart.addEventListener('legendItemClick', event => {
  console.log(event.detail); // { index: number; partyId: string; label: string; disabled: boolean }
});

pointToggled

CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive.

Event name: pointToggled. Names are case-sensitive. Read the payload from detail on CustomEvent<{ index: number; seriesId: string; disabled: boolean }>.

chart.addEventListener('pointToggled', event => {
  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }
});

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

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

• ItemChartTooltipShowEventDetail

  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: ItemChartTooltipActionEventDetail. Event names are case-sensitive.

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

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

• ItemChartTooltipActionEventDetail

  Type definition

zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows.

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

redraw

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

redraw(): Promise<ItemChartRenderResult>

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

• ItemChartRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<ItemChartEngineTier>

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

• ItemChartEngineTier

  Type definition

addParty

Item-only — add a party (datum) to the parliament.

addParty(datum: ItemChartDatum, opts?: { insertAt?: number }): Promise<number>

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

• ItemChartDatum

  Type definition

removeParty

Item-only — remove a party by id, name, or index.

removeParty(idOrIndex: string | number): Promise<boolean>

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

updateParty

Item-only — patch a party's datum fields.

updateParty(idOrIndex: string | number, patch: Partial<Exclude<ItemChartDatum, number>>): Promise<boolean>

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

• ItemChartDatum

  Type definition

setPartySeats

Item-only — set a party's seat count.

setPartySeats(idOrIndex: string | number, value: number): Promise<boolean>

Return type: Promise<boolean>. 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(datum: ItemChartDatum): Promise<void>

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

• ItemChartDatum

  Type definition

appendBatch

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

appendBatch(datums: ReadonlyArray<ItemChartDatum>): Promise<void>

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

• ItemChartDatum

  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(datums: ReadonlyArray<ItemChartDatum>): Promise<void>

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

• ItemChartDatum

  Type definition

getStreamSource

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

getStreamSource(): Promise<ItemChartStreamSource | undefined>

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

• ItemChartStreamSource

  Type definition

setAnimation

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

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

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

• ItemChartEasing

  Type definition

• ItemChartAnimationType

  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 angular-wipe reveal. No-op when animation is off.

replayAnimation(): Promise<void>

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

hitTestSeat

Item-only — hit-test the seat dot at canvas-relative coordinates.

hitTestSeat(cssX: number, cssY: number): Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>

Return type: Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>. Call the method after element registration and await its Promise result.

showTooltipAtParty

Item-only — programmatic tooltip open on a party.

showTooltipAtParty(idOrIndex: string | number): Promise<ItemChartPointEventDetail | null>

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

• ItemChartPointEventDetail

  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.

zoomTo

Zoom to explicit viewport windows: x / y as { min, max } or [min, max] over 0..1 (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 viewport units ({ x?, y? }, 1 = the whole drawing); 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 (0..1 on both orientations, key '0').

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

getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): always Standard (this type has no WebGPU renderer); read without side effects, never consults the license.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  Type definition