IChartHoneycombProps

interface
Chart

Props for <OrigamChartHoneycomb> — hexagonal tile-map where each tile is positioned by column (x) and row (y) index. 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.

typescript

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.

orientation
TChartHoneycombOrientation
Hex vertex orientation. 'pointy-top' — vertex at the top (default). 'flat-top' — flat edge at the top.
colorMode
TChartHoneycombColorMode
Colour-mapping strategy. 'categorical' — intent cycle; 'heatmap' — gradient between heatmapColorRange endpoints.
heatmapColorRange
[TIntent | string, TIntent | string]
Two-stop colour range for colorMode='heatmap'. First entry = min, second = max. Default ['info', 'danger'].
tileSize
number
Hex side-length in SVG user units. Default 30.
tileGap
number
Gap between adjacent tiles in SVG user units. Default 2.
showLabel
boolean
Render the tile's name (or value) as text centred in the tile. Default true.
xAxisFormat
(value: number | string) => string
X-axis / column formatter applied to the numeric x index in tooltip / axis text.
yAxisFormat
(value: number) => string
Y-axis / row formatter applied to the numeric y index.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Categorical tile-map with flat-top orientation

vue