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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- 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.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
GitHub-style activity heatmap