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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- indexrequirednumber
- Position of this bullet in the original series array.
- categoryrequiredstring
- Category label from categories[index] or series[index].name.
- datumrequiredIChartBulletDatum
- Raw datum ({value, target, ranges}).
- visiblerequiredboolean
- Whether this bullet is currently visible (legend toggle).
- barFillrequiredstring
- Resolved fill colour for the actual-value bar.
- targetStrokerequiredstring
- Resolved stroke colour for the target tick.
- rangeFillsrequiredArray<string>
- Resolved fills for each range band, parallel to datum.ranges.
- slotXrequirednumber
- SVG x of the bullet slot origin (horizontal: left edge; vertical: top edge).
- slotYrequirednumber
- SVG y of the bullet slot origin.
- slotWrequirednumber
- Total slot width (horizontal: plot width; vertical: slot column width).
- slotHrequirednumber
- Total slot height (horizontal: slot row height; vertical: plot height).
- maxRangerequirednumber
- 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