IChartParetoProps
interface
Chart
Props for <OrigamChartPareto> — combines vertical columns sorted descending by value with a cumulative percentage line on a secondary right Y-axis. Typical uses: quality control, root-cause analysis, 80/20 rule. Extends IChartBaseProps.
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.
- barColorTIntent | string
- Colour of all columns. Accepts a TIntent token or any raw CSS colour string. Default 'primary'.
- lineColorTIntent | string
- Colour of the cumulative percentage line. Default 'danger'.
- barGapnumber
- Gap in SVG pixels between adjacent columns. Default 4.
- showLineboolean
- Whether to render the cumulative percentage line. Default true.
- showLabelboolean
- Whether to show a value label above each column. Default false.
- showAxisboolean
- Render X (category) and Y (value + percentage) axes. Default true.
- showGridboolean
- Render horizontal grid lines aligned with Y-axis ticks. Default true.
- xAxisFormat(value: string | number) => string
- Formatter applied to X-axis category tick labels.
- yAxisFormat(value: number) => string
- Formatter applied to the left Y-axis (value) tick labels.
- cumulativeFormat(value: number) => string
- Formatter applied to the right Y-axis (cumulative %) tick labels. Default formats as rounded integer percentage, e.g. "80%".
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Pareto chart for defect root-cause analysis