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.

typescript

API

Properties

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

index
required
number
Category index (position in the data array).
category
required
string
Category label.
stats
required
{ min: number q1: number median: number q3: number max: number }
Resolved five-number summary already coerced to SVG Y coords.
rawStats
required
{ min: number q1: number median: number q3: number max: number }
Raw numeric five-number summary in data-space values.
iqr
required
number
IQR = Q3 − Q1 in data space.
svgQ3
required
number
SVG Y coordinate for Q3 (top of box rect).
svgQ1
required
number
SVG Y coordinate for Q1 (bottom of box rect).
svgMedian
required
number
SVG Y coordinate for the median line.
svgMax
required
number
SVG Y coordinate for the upper whisker tip.
svgMin
required
number
SVG Y coordinate for the lower whisker tip.
boxHeight
required
number
Pre-computed box rectangle height (|svgQ1 − svgQ3|) to avoid template-level Math.abs().
cx
required
number
SVG X centre of the slot.
halfBoxW
required
number
Half-width of the box rectangle.
halfCapW
required
number
Half-width of the whisker cap segment.
color
required
string
Resolved CSS colour string for this box.
outliers
required
Array<{ svgY: number, value: number }>
SVG Y coordinates and raw values of each outlier dot.
visible
required
boolean
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

vue