IChartBoxPlotBox
interface
Chart
Internal box descriptor produced by the OrigamChartBoxPlot geometry engine for each category slot. All coordinates are in SVG-space pixels. Consumed directly by the SVG renderer and exposed through the #tooltip slot.
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.
- indexrequirednumber
- Category index (position in the data array).
- categoryrequiredstring
- Category label.
- statsrequired{ min: number q1: number median: number q3: number max: number }
- Resolved five-number summary already coerced to SVG Y coords.
- rawStatsrequired{ min: number q1: number median: number q3: number max: number }
- Raw numeric five-number summary in data-space values.
- iqrrequirednumber
- IQR = Q3 − Q1 in data space.
- svgQ3requirednumber
- SVG Y coordinate for Q3 (top of box rect).
- svgQ1requirednumber
- SVG Y coordinate for Q1 (bottom of box rect).
- svgMedianrequirednumber
- SVG Y coordinate for the median line.
- svgMaxrequirednumber
- SVG Y coordinate for the upper whisker tip.
- svgMinrequirednumber
- SVG Y coordinate for the lower whisker tip.
- boxHeightrequirednumber
- Pre-computed box rectangle height (|svgQ1 − svgQ3|) to avoid template-level Math.abs().
- cxrequirednumber
- SVG X centre of the slot.
- halfBoxWrequirednumber
- Half-width of the box rectangle.
- halfCapWrequirednumber
- Half-width of the whisker cap segment.
- colorrequiredstring
- Resolved CSS colour string for this box.
- outliersrequiredArray<{ svgY: number, value: number }>
- SVG Y coordinates and raw values of each outlier dot.
- visiblerequiredboolean
- Whether this box is currently visible after legend toggle.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Accessing IChartBoxPlotBox in the #tooltip slot