IChartBoxPlotDatum
interface
Chart
Pre-aggregated datum for OrigamChartBoxPlot — the consumer supplies all five-number-summary values (min, q1, median, q3, max) and optional outlier array directly. Use IChartBoxPlotRawDatum when raw samples should be aggregated by the component.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- categoryrequiredstring
- Category label shown on the X axis.
- minrequirednumber
- Minimum (lower fence or true min when no outliers).
- q1requirednumber
- First quartile — Q1 (25th percentile).
- medianrequirednumber
- Median — Q2 (50th percentile).
- q3requirednumber
- Third quartile — Q3 (75th percentile).
- maxrequirednumber
- Maximum (upper fence or true max when no outliers).
- outliersArray<number>
- Values lying outside the 1.5·IQR whisker fences.
- colorTIntent | string
- Override colour for this datum. Intent token or raw CSS colour. When absent the category index cycles through colorScheme.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Pre-aggregated box plot data