Column

series

Names, values, and colors for each group.

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

• ColumnChartSeries

  Type definition

activeSeriesIndex

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.

seriesState

Pass as a JavaScript property. type: ColumnChartSeriesStateOptions.

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

• ColumnChartSeriesStateOptions

  Type definition

seriesActiveTrigger

Allowed values: hover, click, custom. Default: 'hover'.

• ColumnChartSeriesActiveTrigger

  Type definition

values

Use a number array for a single series.

• ColumnChartValues

  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.

color

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

thickness

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

barPadding

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

seriesPadding

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

baseline

Value the columns grow from. Always explicit (default 0) so the start point of every column is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero.

stacking

Allowed values: normal, percent. Default: undefined.

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

• CartesianSeriesStackingMode

  Type definition

borderRadius

Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue.

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

• CartesianSeriesCornerRadiusValue

  Type definition

borderScope

Allowed values: point, stack, outline. Default: 'stack'.

• ColumnBorderScope

  Type definition

borderColor

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.

borderWidth

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.

borderDashStyle

Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined.

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

• CartesianSeriesBorderDashStyle

  Type definition

inactiveOtherPoints

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

inactivePointOpacity

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

engine

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

• ColumnChartEngineMode

  Type definition

proThreshold

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

unavailable

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

• ColumnChartUnavailableBehaviour

  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.

• ColumnChartStreamSource

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

• ColumnChartEasing

  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.

• ColumnChartAnimationType

  Type definition

legend

Whether to show a legend for series or items.

legendPosition

Where the legend is positioned.

• ColumnChartLegendPosition

  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

seriesName

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.

legendFloatAlign

Allowed values: start, center, end. Default: 'end'.

legendFloatVerticalAlign

Allowed values: top, bottom, middle. Default: 'top'.

legendDraggable

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

xAxis

categories determines the bar order.

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.

• CartesianYAxisInput

  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.

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

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

gridLines

Allowed values: auto, off. Default: undefined.

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

• CartesianGridLinesInput

  Type definition

zoom

zoom: 'x' | 'y' | 'xy' | true (x) enable the drag rectangle + keyboard (+ / - / Escape) on the primary axes; an object refines mode / drag / keyboard / minRangePx / resetButton. Off by default. zoomTo / zoomBy / resetZoom work regardless of the gesture switches.

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

• CartesianZoomInput

  Type definition

brush

brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default.

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

• CartesianBrushInput

  Type definition

drawings

the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts).

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

• ChartDrawingsInput

  Type definition

drawingMode

the pointer disposition: 'none' (default), 'draw' (the plain drag places drawingTool; precedence drawing > brush > zoom > pan), 'select' ().

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

• DrawingModeInput

  Type definition

drawingTool

the tool drawingMode="draw" places (a registered tool name; default 'segment').

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

drawingSpace

the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes).

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

• DrawingSpace

  Type definition

visualMap

a visual map binding (a sy-visual-map snapshot + the data dimension): every mark is coloured through it.

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

• VisualMapBinding

  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<ColumnChartRenderResult & { tier: ColumnChartEngineTier }>.

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

• ColumnChartRenderResult

  Type definition

• ColumnChartEngineTier

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

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

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

fired after every zoom change (drag / keyboard / api / reset) with the new state.

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

brushChange

the brush areas / selection changed (drag, api, clear, keyboard).

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

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

• CartesianBrushChangeEventDetail

  Type definition

brushStart

a brush drag opened up (once per gesture).

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

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

• CartesianBrushStartEventDetail

  Type definition

brushMove

a live frame of the drag (throttled; the selection only with liveSelection).

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

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

• CartesianBrushMoveEventDetail

  Type definition

brushEnd

the drag released (after brushChange), or was cancelled.

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

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

• CartesianBrushEndEventDetail

  Type definition

drawingsChange

the drawing document changed (a placement, the api, undo / redo, clear, the prop).

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

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

• DrawingsChangeEventDetail

  Type definition

drawingSelectionChange

the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it).

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

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

• DrawingSelectionChangeEventDetail

  Type definition

pointHover

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

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

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

• CartesianPointEventDetail

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

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

• CartesianPointEventDetail

  Type definition

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  Type definition

• CartesianPointEventDetail

  Type definition

seriesOutsideClick

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

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

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

• CartesianSeriesOutsideClickEventDetail

  Type definition

legendItemClick

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

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

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

• ColumnChartLegendItemEventDetail

  Type definition

seriesToggled

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

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

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

• ColumnChartSeriesToggledEventDetail

  Type definition

redraw

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

redraw(): Promise<ColumnChartRenderResult>

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

• ColumnChartRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<ColumnChartEngineTier>

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

• ColumnChartEngineTier

  Type definition

appendPoint

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

appendPoint(value: number): Promise<void>

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

appendBatch

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

appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>

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

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(values: ReadonlyArray<number> | Float32Array): 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<ColumnChartStreamSource | undefined>

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

• ColumnChartStreamSource

  Type definition

getEngineStatus

The requested engine, the engine that draws and why . A Chart Pro license decision names chart.webgpu and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  Type definition

setAnimation

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

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

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

• ColumnChartEasing

  Type definition

• ColumnChartAnimationType

  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.

addSeries

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

addSeries(options: ColumnChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>

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

• ColumnChartSeries

  Type definition

removeSeries

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

removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>

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

updateSeries

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

updateSeries(idOrIndex: string | number, patch: Partial<ColumnChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>

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

• ColumnChartSeries

  Type definition

setSeriesData

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

setSeriesData(idOrIndex: string | number, data: ColumnChartValues, opts?: { redraw?: boolean }): Promise<boolean>

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

• ColumnChartValues

  Type definition

addPoint

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

addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>

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

showSeries

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

showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>

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

hideSeries

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

hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>

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

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(pointIndex: 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.

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 | 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 data 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 — master axes (null before the first layout).

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

showCrosshairAt

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

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

getDrawings

the drawings of the document (data-space anchors).

getDrawings(): Promise<ChartDrawing[]>

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

• ChartDrawing

  Type definition

setDrawings

replace the document from script (null clears); the history keeps the previous document as an undo step.

setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

• ChartDrawingInput

  Type definition

addDrawing

add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed.

addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>

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

• ChartDrawing

  Type definition

• ChartDrawingInput

  Type definition

updateDrawing

merge a patch into one drawing (anchors, style, visible, locked, options, meta).

updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>

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

• ChartDrawing

  Type definition

removeDrawing

remove one drawing.

removeDrawing(id: string): Promise<boolean>

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

removeDrawings

remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself.

removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

setDrawingSpace

move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step.

setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>

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

• ChartDrawing

  Type definition

• DrawingSpace

  Type definition

clearDrawings

clear the document (undoable).

clearDrawings(): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

undoDrawing

undo the last document change; null when there is nothing to undo.

undoDrawing(): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

redoDrawing

redo the last undone change; null when there is nothing to redo.

redoDrawing(): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

getDrawingLayer

the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export.

getDrawingLayer(): Promise<DrawingLayerSnapshot | null>

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

• DrawingLayerSnapshot

  Type definition

exportDrawings

the document as its versioned JSON envelope (feed it back through drawings or importDrawings).

exportDrawings(): Promise<string>

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

importDrawings

replace the document from an envelope / list / JSON string (undoable; malformed rows drop).

importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>

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

• DrawingsChangeEventDetail

  Type definition

• ChartDrawingsInput

  Type definition

selectDrawings

select drawings from script (null / [] clears); unknown ids are dropped.

selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>

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

• DrawingSelectionChangeEventDetail

  Type definition

getDrawingSelection

the selected drawing ids.

getDrawingSelection(): Promise<string[]>

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

setBrush

replace the brush areas from script (null clears); brushChange fires with source 'api'.

setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>

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

• CartesianBrushChangeEventDetail

  Type definition

• CartesianBrushAreaInput

  Type definition

clearBrush

clear the brush areas (brushChange with source 'clear').

clearBrush(): Promise<CartesianBrushChangeEventDetail | null>

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

• CartesianBrushChangeEventDetail

  Type definition

getBrush

the persisted brush areas (primary data space).

getBrush(): Promise<CartesianBrushArea[]>

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

• CartesianBrushArea

  Type definition

getBrushSelection

the points inside the brush areas, against the current layout.

getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>

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

• CartesianBrushSelectedSeries

  Type definition

setVisualMap

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

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 of a dimension over the visible points — what a bound sy-visual-map adopts as its domain.

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

hitTestPoint

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

hitTestPoint(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>

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