IChartBulletProps
interface
Chart
Props for <OrigamChartBullet> — the bullet / KPI chart family. Each series entry renders one bullet combining range bands, an actual-value bar, and a target marker tick (Stephen Few design).
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- categoriesArray<string>
- Category labels — one per series entry. Rendered beside each bullet. Falls back to series[i].name when omitted.
- barColorTIntent | string'primary'
- Fill colour for the actual-value bar. Accepts a TIntent token or a raw CSS colour. Default 'primary'.
- targetColorTIntent | string'danger'
- Stroke colour for the target marker tick. Default 'danger'.
- rangeColorsArray<TIntent | string>['danger', 'warning', 'success']
- Fallback palette used when range.color is omitted. Cycled in array order across bands.
- orientationTDirection'horizontal'
- Layout direction. 'horizontal' renders bullets as rows; 'vertical' renders bullets as columns. Default 'horizontal'.
- barThicknessnumber0.45
- Thickness of the actual-value bar as a fraction of the slot height (horizontal) or slot width (vertical). Range [0, 1].
- showAxisbooleantrue
- Show the quantitative axis. Default true.
- xAxisFormat(value: string | number) => string
- X-axis tick formatter applied to axis tick labels.
- yAxisFormat(value: number) => string
- Y-axis tick formatter applied to axis tick labels (vertical orientation).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Horizontal bullet chart with three KPI bullets