Grafit charts

English

Русский

English

Русский

Appearance

grafit-charts

Interface: TreemapSeriesOptions ​

Extends ​

  • StandaloneSeriesBaseOptions

Properties ​

childrenField? ​

optional childrenField?: string

fills? ​

optional fills?: string[]

Inherited from ​

StandaloneSeriesBaseOptions.fills

groupGap? ​

optional groupGap?: number

The same, between neighbouring groups; falls back to itemGap.

groupHeader? ​

optional groupHeader?: TreemapGroupHeaderOptions

The strip a group is named in: how tall it is, what it is filled with and the font of its text. Transparent by default, so a header reads as a heading over the group rather than as a tile of its own.

groupHeaderHeight? ​

optional groupHeaderHeight?: number

Deprecated ​

use groupHeader.height.

id? ​

optional id?: string

Inherited from ​

StandaloneSeriesBaseOptions.id

itemGap? ​

optional itemGap?: number

Gap between neighbouring tiles (2 by default). Only between them: a tile on the edge of its group — or of the chart — keeps that edge, so the padding of the plot stays the padding of the plot.

label? ​

optional label?: TreemapLabelOptions

Tile labels: the name of a node and its value, drawn as one block so the two always read together — each half with its own font, layout putting the value on a line of its own (default) or in the same row. Enabled by default, name only; the color is auto-contrast against the tile. A label that does not fit its tile is not drawn.

labelField? ​

optional labelField?: string

labelName? ​

optional labelName?: Formattable<PartNameParams>

How the value of labelField becomes text — for the legend, the tooltip heading, the group header and the name half of a tile label alike. A name is a field value, and the format of that field belongs to the series rather than to each place the name is printed in. label.category overrides it where a tile wants something shorter than the legend.

name? ​

optional name?: string

Name of what the value of a node measures — the label of the tooltip row. Without it the row is named by the data key the value came from, which is the name of a column, not of a measure.

Inherited from ​

StandaloneSeriesBaseOptions.name

showInLegend? ​

optional showInLegend?: boolean

Inherited from ​

StandaloneSeriesBaseOptions.showInLegend

sizeField? ​

optional sizeField?: string

tooltip? ​

optional tooltip?: Switchable & object

Type Declaration ​

renderer? ​

optional renderer?: (params) => string | TooltipContentData

Parameters ​
params ​

NodeTooltipRendererParams

Returns ​

string | TooltipContentData

Inherited from ​

StandaloneSeriesBaseOptions.tooltip

type ​

type: "treemap"

visible? ​

optional visible?: boolean

Inherited from ​

StandaloneSeriesBaseOptions.visible