IChartHoneycombProps

interface
Chart

Props for <OrigamChartHoneycomb> — hexagonal tile-map where each tile is positioned by column (x) and row (y) index. Extends IChartBaseProps.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

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.

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.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Categorical tile-map with flat-top orientation

vue