Documentation / @ripl/charts / BoxPlotChartOptions
Interface: BoxPlotChartOptions<TData> ​
Defined in: charts/src/charts/box-plot.ts:92
Options for configuring a BoxPlotChart.
Extends ​
CartesianChartOptions<TData>
Type Parameters ​
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | CartesianChartOptions.animation | charts/src/core/chart.ts:128 |
annotations? | ChartAnnotation[] | Reference lines, shaded bands, and point markers drawn over the plot. See ChartAnnotation. | CartesianChartOptions.annotations | charts/src/core/cartesian.ts:231 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | CartesianChartOptions.autoRender | charts/src/core/chart.ts:122 |
axis? | ChartAxisInput<TData> | X/y axis configuration, or a boolean toggling both axes. See ChartAxisInput. | CartesianChartOptions.axis | charts/src/core/cartesian.ts:221 |
categoryOrder? | string[] | Explicit category order (defaults to first-seen order in the data). | - | charts/src/charts/box-plot.ts:100 |
color? | string | Color used for every box; falls back to the first palette color when omitted. | - | charts/src/charts/box-plot.ts:102 |
crosshair? | ChartCrosshairInput | Crosshair configuration, or a boolean toggle. See ChartCrosshairInput. | CartesianChartOptions.crosshair | charts/src/core/cartesian.ts:229 |
data | TData[] | The dataset summarized by the chart. | - | charts/src/charts/box-plot.ts:94 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | CartesianChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | Format applied to summary values shown in tooltips. | - | charts/src/charts/box-plot.ts:104 |
grid? | ChartGridInput | Background grid configuration, or a boolean toggle. See ChartGridInput. | CartesianChartOptions.grid | charts/src/core/cartesian.ts:223 |
key | keyof TData | ((item) => string) | Accessor for the category each value belongs to. | - | charts/src/charts/box-plot.ts:96 |
legend? | ChartLegendInput | Legend configuration, a position string, or a boolean toggle. See ChartLegendInput. | CartesianChartOptions.legend | charts/src/core/cartesian.ts:227 |
navigator? | boolean | NavigatorInteractions | Enables pan/zoom (and optionally brush) navigation on the plot. true turns on wheel-zoom and click-drag pan; an object configures each interaction individually. The chart auto-creates a DOMNavigator on its context and rescales the axis domains as the view changes, with no data rebuild. Access the underlying controller via chart.navigator for imperative framing (centerOn/fitBounds) or brush-and-link. | CartesianChartOptions.navigator | charts/src/core/cartesian.ts:239 |
overview? | boolean | ChartOverviewOptions | Enables an overview "scrub bar" strip beside the plot with a draggable window that selects the visible range of the category axis (a bottom bar for category-on-x charts, a side bar for a horizontal bar chart). true uses the default size; an object sets it. Enabling the strip also turns on in-plot wheel/drag pan-zoom (category-axis only) unless navigator is explicitly false. Only category-axis charts (line, area, bar, trend) render the strip. | CartesianChartOptions.overview | charts/src/core/cartesian.ts:247 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | CartesianChartOptions.padding | charts/src/core/chart.ts:124 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | CartesianChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | CartesianChartOptions.title | charts/src/core/chart.ts:126 |
tooltip? | ChartTooltipInput | Hover-tooltip configuration, or a boolean toggle. See ChartTooltipInput. | CartesianChartOptions.tooltip | charts/src/core/cartesian.ts:225 |
value | NumericAccessor<TData> | Accessor for the numeric value to summarize. | - | charts/src/charts/box-plot.ts:98 |