series[type=' treemap']
- type required
'treemap' - Configuration for the Treemap Series.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- context
ContextDefault - Context object to use in callbacks.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- visible
boolean - Whether to display the series.
- cursor
string - The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
- nodeClickRange
InteractionRange - Range from a node that a click triggers the listener.
- listeners
AgSeriesListeners - A map of event names to event listeners.
- labelKey
string - The name of the node key containing the label.
- secondaryLabelKey
string - The name of the node key containing a secondary label.
- childrenKey
string - The name of the node key containing the children. Defaults to `children`.
- sizeKey
string - The name of the node key containing the size value.
- colorKey
string - The name of the node key containing the colour value. This value (along with `colorScale` config) will be used to determine the tile colour.
- sizeName
string - A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- colorName
string - A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- fills
AgColorType[] - The colours to cycle through for the fills of the groups and tiles. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The colours to cycle through for the strokes of the groups and tiles.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- group
AgTreemapSeriesGroupOptions - Options for group nodes (i.e. nodes WITH children).
- tile
AgTreemapSeriesTileOptions - Options for leaf nodes (i.e. nodes WITHOUT children).
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular tile based on the input parameters.
series[type=' treemap']
- type required
'treemap' - Configuration for the Treemap Series.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- context
ContextDefault - Context object to use in callbacks.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- visible
boolean - Whether to display the series.
- cursor
string - The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
- nodeClickRange
InteractionRange - Range from a node that a click triggers the listener.
- listeners
AgSeriesListeners - A map of event names to event listeners.
- labelKey
string - The name of the node key containing the label.
- secondaryLabelKey
string - The name of the node key containing a secondary label.
- childrenKey
string - The name of the node key containing the children. Defaults to `children`.
- sizeKey
string - The name of the node key containing the size value.
- colorKey
string - The name of the node key containing the colour value. This value (along with `colorScale` config) will be used to determine the tile colour.
- sizeName
string - A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- colorName
string - A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- fills
AgColorType[] - The colours to cycle through for the fills of the groups and tiles. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The colours to cycle through for the strokes of the groups and tiles.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- group
AgTreemapSeriesGroupOptions - Options for group nodes (i.e. nodes WITH children).
- tile
AgTreemapSeriesTileOptions - Options for leaf nodes (i.e. nodes WITHOUT children).
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular tile based on the input parameters.