IChartVariwideProps
interface
Chart
Props for <OrigamChartVariwide>. A variwide chart encodes two metrics per category: height for the primary value (Y axis) and width for the secondary value (proportional share of the plot width). Typical uses: GDP × population, revenue × market share, response time × request count.
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.
- barGapnumber2
- Gap in SVG pixels between adjacent columns.
- showLabelbooleantrue
- Show the value label above each column.
- showAxisbooleantrue
- Render X (category) and Y (value) axes.
- showGridbooleantrue
- Render horizontal grid lines aligned with Y-axis ticks.
- xAxisFormat(value: string | number) => string
- Formatter applied to X-axis category tick labels. When omitted the category string is shown as-is.
- yAxisFormat(value: number) => string
- Formatter applied to Y-axis value tick labels and to the primary-value display in tooltip and above-bar label.
- yMinnumber
- Override the auto-computed Y minimum. Useful when the data starts well above zero.
- yMaxnumber
- Override the auto-computed Y maximum.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
GDP × population variwide chart