IChartBoxPlotProps

interface
Chart

Props for OrigamChartBoxPlot — extends IChartBaseProps with box-plot-specific controls: category order, box width, whisker cap width, outlier visibility, axis/grid visibility, Y-axis range overrides and axis label formatters.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

categories
Array<string>
Explicit category order. When absent the order is inferred from the first occurrence of each category in series[0].data.
boxWidth
number
Box width as a fraction of the per-category slot width. Range [0, 1]. Default 0.6.
whiskerCapWidth
number
Whisker cap width as a fraction of the per-category slot width. Range [0, 1]. Default 0.4.
showOutliers
boolean
Render outlier dots beyond the whisker fences. Default true.
showAxis
boolean
Render X and Y axes. Default true.
showGrid
boolean
Render horizontal grid lines. Default true.
yMin
number
Override the auto-computed Y-axis minimum. When absent the component uses min(data) − 10% padding.
yMax
number
Override the auto-computed Y-axis maximum. When absent the component uses max(data) + 10% padding.
xAxisFormat
(value: string | number) => string
Formatter applied to X-axis category labels. Default: identity (category string returned as-is).
yAxisFormat
(value: number) => string
Formatter applied to Y-axis tick values. Default: String(value).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Box plot with custom box width and Y-axis formatter

vue