IChartBulletBullet

interface
Chart

Pre-computed geometry descriptor for a single bullet in a bullet chart. Produced by the bullet layout engine inside OrigamChartBullet — contains resolved colours, slot coordinates, and the maximum axis value.

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
Position of this bullet in the original series array.
category
required
string
Category label from categories[index] or series[index].name.
datum
required
IChartBulletDatum
Raw datum ({value, target, ranges}).
visible
required
boolean
Whether this bullet is currently visible (legend toggle).
barFill
required
string
Resolved fill colour for the actual-value bar.
targetStroke
required
string
Resolved stroke colour for the target tick.
rangeFills
required
Array<string>
Resolved fills for each range band, parallel to datum.ranges.
slotX
required
number
SVG x of the bullet slot origin (horizontal: left edge; vertical: top edge).
slotY
required
number
SVG y of the bullet slot origin.
slotW
required
number
Total slot width (horizontal: plot width; vertical: slot column width).
slotH
required
number
Total slot height (horizontal: slot row height; vertical: plot height).
maxRange
required
number
Maximum axis value = max(ranges[-1].to, target, value).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading the bullet descriptor in a custom tooltip slot

vue