IChartHeatmapProps
interface
Chart
Props for <OrigamChartHeatmap> — rectangular heatmap grid where each cell is coloured by its value relative to the dataset min/max. 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.
- xCategoriesArray<string>
- Explicit X-axis category ordering. When omitted, unique x values are sorted alphabetically / numerically.
- yCategoriesArray<string>
- Explicit Y-axis category ordering. When omitted, unique y values are sorted alphabetically / numerically.
- colorRange[TIntent | string, TIntent | string]
- Two-stop colour range used to interpolate cell colour. First entry = min value colour, second = max value colour. Default ['info', 'danger'].
- cellGapnumber
- Gap between cells in SVG user units. Default 2.
- showLabelboolean
- Render the numeric value centred inside each cell when the cell is wide/tall enough. Default true.
- showAxisboolean
- Render X and Y axis category labels along the grid edges. Default true.
- showGradientLegendboolean
- Gradient legend bar with min / max labels. Default true.
- legendPositionTChartLegendPosition
- Anchor of the gradient legend. Default 'bottom'.
- xAxisFormat(value: string | number) => string
- X-axis category label formatter. Applied to each column label.
- yAxisFormat(value: number) => string
- Y-axis / value formatter. Applied to row labels AND to the min/max labels on the gradient legend.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
GitHub-style activity heatmap