API / Series/Treemap / TreemapSeries
Defined in: src/types/chart/treemap.ts:21
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
color? |
string |
The main color of the series (hex, rgba). |
cursor? |
string |
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. |
data |
TreemapSeriesData<T>[] |
- |
dataLabels? |
object & object |
Options for the series data labels, appearing next to each data point. |
layoutAlgorithm? |
"slice" | "binary" | "dice" | "slice-dice" | "squarify" |
- |
legend? |
ChartLegend & object |
Individual series legend options. Has higher priority than legend options in widget data. |
levels? |
object[] |
Set options on specific levels. Takes precedence over series options, but not point options. |
name |
string |
The name of the series (used in legend, tooltip etc). |
sorting? |
object |
Data sorting settings (affects the order in which blocks are displayed inside the chart). If the option is not specified, the data is displayed in the order defined by the user. |
sorting.direction? |
"asc" | "desc" |
The sorting direction. @default: 'desc' |
sorting.enabled? |
boolean |
Enable or disable sorting. |
type |
"treemap" |
- |
visible? |
boolean |
Initial visibility of the series |
Previous