Documentation / @ripl/charts / BoxPlotChartOptions
Interface: BoxPlotChartOptions<TData>
Defined in: charts/src/charts/box-plot.ts:74
Options for configuring a BoxPlotChart.
Extends
CartesianChartOptions<TData>
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Overrides | 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:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | - | CartesianChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | Axis configuration for the category and value axes. | CartesianChartOptions.axis | - | charts/src/charts/box-plot.ts:90 |
categories? | string[] | Explicit category order (defaults to first-seen order in the data). | - | - | charts/src/charts/box-plot.ts:82 |
color? | string | Colour used for every box; falls back to the first palette colour when omitted. | - | - | charts/src/charts/box-plot.ts:84 |
crosshair? | ChartCrosshairInput | Crosshair configuration, or a boolean toggle. See ChartCrosshairInput. | - | CartesianChartOptions.crosshair | charts/src/core/cartesian.ts:129 |
data | TData[] | The dataset summarised by the chart. | - | - | charts/src/charts/box-plot.ts:76 |
format? | ValueFormatInput | Format applied to summary values shown in tooltips. | - | - | charts/src/charts/box-plot.ts:92 |
grid? | ChartGridInput | Background grid configuration (true/false or detailed grid options). | CartesianChartOptions.grid | - | charts/src/charts/box-plot.ts:86 |
group | keyof TData | ((item) => string) | Accessor for the category each value belongs to. | - | - | charts/src/charts/box-plot.ts:78 |
legend? | ChartLegendInput | Legend configuration, a position string, or a boolean toggle. See ChartLegendInput. | - | CartesianChartOptions.legend | charts/src/core/cartesian.ts:127 |
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 — 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:137 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | - | CartesianChartOptions.padding | charts/src/core/chart.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | - | CartesianChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | CartesianChartOptions.tooltip | - | charts/src/charts/box-plot.ts:88 |
value | NumericAccessor<TData> | Accessor for the numeric value to summarise. | - | - | charts/src/charts/box-plot.ts:80 |