IChartParetoBar
interface
Chart
Pre-computed bar descriptor produced by the Pareto geometry engine. Contains all pre-computed values needed to render one <rect> column, its label, and the cumulative percentage dot.
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
- Index in the sorted data array (0 = highest value).
- categoryrequiredstring
- Category label from the datum.
- valuerequirednumber
- Raw numeric value from the datum.
- formattedValuerequiredstring
- Pre-formatted value string.
- sharerequirednumber
- Individual share of total (0–1).
- cumulativerequirednumber
- Cumulative percentage up to and including this bar (0–1).
- colorrequiredstring
- Resolved CSS colour string (for fill).
- xrequirednumber
- SVG X of the left edge of the bar.
- yrequirednumber
- SVG Y of the top edge of the bar.
- wrequirednumber
- Bar width in SVG pixels.
- hrequirednumber
- Bar height in SVG pixels.
- cxrequirednumber
- X center of the bar — used for the X-axis tick label and cumulative line dot.
- dotYrequirednumber
- Y of the cumulative percentage dot on the right Y-axis scale.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Accessing bar descriptors from the Pareto engine