IChartTreemapProps

interface
Data Visualisation

Props for OrigamChartTreemap. Consumes series[0] only — each item in series[0].data becomes one tile sized proportionally to its value. v1 renders a flat single-level treemap; nested children are accepted for forward compatibility but not rendered. 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.

algorithm
TChartTreemapAlgorithm
'squarified'
Layout algorithm. 'squarified' — minimises tile aspect ratio (default). 'slice-dice' — alternates horizontal / vertical slicing.
showLabel
boolean
true
Whether to render the name + value text inside each tile when the tile is at least 60 × 24 SVG-px.
yAxisFormat
(value: number) => string
Formatter applied to the numeric value in tile labels and the tooltip. Raw number stringified when absent.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Squarified treemap with a K-suffix formatter

vue