IChartHeatmapSlots

interface
Chart

Slot signatures exposed by <OrigamChartHeatmap>. Extends IChartBaseSlots with a custom tooltip slot for hovered cells.

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.

tooltip
(bindings: { point: IChartPoint color: string xLabel: string yLabel: string value: number }) => any
Replace the tooltip body for a hovered cell. Receives the hovered point, its resolved colour, and the formatted x / y / value strings.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom tooltip for a heatmap cell

vue