Box Plot

data

Pass raw samples as { category, values: [...] } or provide summary statistics.

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

• BoxPlotData

  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.

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.

• XAxisInput

  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: the value axis's on by default, the category axis's off (a category axis has no continuous grid).

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: 'x' | 'y' | 'xy' | true (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (+ / - / Escape) on the primary axes; an object refines them (mode / drag / pan / wheel / pinch / keyboard / minRangePx / resetButton / inside). Off by default; zoomTo / zoomBy / panBy / 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

yMin

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.

yMax

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.

padding

The automatic domain pads the value span by this share (default 5 %).

orientation

The direction in which boxes are drawn.

• BoxPlotOrientation

  Type definition

boxColor

The box colour: its border (and, at box-fill-alpha, its fill); auto whiskers / outliers follow it.

boxFillAlpha

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

medianColor

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

whiskerColor

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

outlierColor

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

boxWidth

The box's share of the slot pitch (0.6), clamped between box-min-px and box-max-px.

boxMinPx

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

boxMaxPx

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

capWidth

The whisker caps' share of the box width (0.5; 0 hides them).

whiskerWidth

CSS px: the whisker / border thickness, the median thickness, the outlier radius.

medianWidth

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

outlierRadius

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

notched

the stepped notch: the box narrows to notch-width of itself between the notch bounds (median ± 1.57 × IQR / √n).

notchWidth

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

showMean

the mean marker: a mean-size px square in mean-color (auto = the median colour) at the mean.

meanColor

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

meanSize

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

whiskerRule

tukey (1.5 × IQR, the default), min-max (no outliers), percentile (), or a number of IQRs.

• BoxPlotWhiskerRule

  Type definition

quantileMethod

the quantile method: linear (R-7, the default), exclusive (R-6), nearest, lower, higher, midpoint.

• BoxPlotQuantileMethod

  Type definition

whiskerPercentile

the percentile whisker rule's p (0 … 50, default 5: the whiskers at Q(p %) and Q(100 − p %)).

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 box tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text.

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

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

• BoxPlotPointEventDetail

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

• BoxPlotEasing

  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.

• BoxPlotAnimationType

  Type definition

streamSource

§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push.

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

• BoxPlotStreamSource

  Type definition

streamMax

Categories tracked by the internal stream at most (the oldest leave as windowSlid).

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 items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their boxes, older streamed categories revert to their data box or leave.

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.

• BoxPlotEngineMode

  Type definition

unavailable

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

• BoxPlotUnavailableBehaviour

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

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

• BoxPlotRenderResult

  Type definition

• BoxPlotEngineTier

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

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

• BoxPlotPointEventDetail

  Type definition

pointHover

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

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

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

• BoxPlotPointEventDetail

  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

zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / 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

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  Type definition

• BoxPlotPointEventDetail

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

tooltipShow

the shared tooltip events (the controller emits them).

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

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

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

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

• BoxPlotRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<BoxPlotEngineTier>

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

• BoxPlotEngineTier

  Type definition

getUnavailableReason

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

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: BoxPlotData): Promise<void>

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

• BoxPlotData

  Type definition

appendPoint

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

appendPoint(datum: BoxPlotDatumInput): Promise<void>

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

• BoxPlotDatumInput

  Type definition

appendBatch

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

appendBatch(data: ReadonlyArray<BoxPlotDatumInput>): Promise<void>

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

• BoxPlotDatumInput

  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(data: ReadonlyArray<BoxPlotDatumInput>): Promise<void>

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

• BoxPlotDatumInput

  Type definition

getStreamSource

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

getStreamSource(): Promise<BoxPlotStreamSource | undefined>

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

• BoxPlotStreamSource

  Type definition

setAnimation

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

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

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

• BoxPlotEasing

  Type definition

• BoxPlotAnimationType

  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.

hitTest

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

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

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

• BoxPlotPointEventDetail

  Type definition

getBox

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

getBox(index: number): Promise<BoxPlotBox | null>

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

• BoxPlotBox

  Type definition

getBoxByCategory

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

getBoxByCategory(category: string): Promise<BoxPlotBox | null>

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

• BoxPlotBox

  Type definition

getBoxCount

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

getBoxCount(): Promise<number>

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

getBoxes

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

getBoxes(): Promise<BoxPlotBox[]>

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

• BoxPlotBox

  Type definition

getStatistics

the box with its derived numbers: the IQR, the variance, the whisker rule and its fences, the quantile method.

getStatistics(index: number): Promise<BoxPlotStatistics | null>

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

• BoxPlotStatistics

  Type definition

getCategories

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

getCategories(): Promise<string[]>

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

getExtent

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

getExtent(): Promise<BoxPlotExtent>

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

• BoxPlotExtent

  Type definition

getDomain

The data domain the grid spans.

getDomain(): Promise<BoxPlotDomain>

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

• BoxPlotDomain

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

focusBoxAt

move the keyboard focus ring to a box (null off the boxes); emits pointHover like the walk.

focusBoxAt(index: number): Promise<BoxPlotPointEventDetail | null>

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

• BoxPlotPointEventDetail

  Type definition

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

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