HighchartsTreemapSeriesClusterOptions class

An option to optimize treemap series rendering by grouping smaller leaf nodes below a certain square area threshold in pixels. If the square area of a point becomes smaller than the specified threshold, determined by the pixelWidth and/or pixelHeight options, then this point is moved into one group point per series.

API Docs: https://api.highcharts.com/highcharts/series.treemap.cluster

Inheritance

Constructors

HighchartsTreemapSeriesClusterOptions.new({String? className, String? color, bool? enabled, double? minimumClusterSize, String? name, double? pixelHeight, double? pixelWidth, double? reductionFactor})
An option to optimize treemap series rendering by grouping smaller leaf nodes below a certain square area threshold in pixels. If the square area of a point becomes smaller than the specified threshold, determined by the pixelWidth and/or pixelHeight options, then this point is moved into one group point per series.

Properties

className ↔ String?
An additional, individual class name for the grouped point's graphic representation.
getter/setter pair
color ↔ String?
Individual color for the grouped point. By default the color is pulled from the parent color.
getter/setter pair
enabled ↔ bool?
Enable or disable Treemap grouping.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
minimumClusterSize ↔ double?
Defines the minimum number of child nodes required to create a group of small nodes.
getter/setter pair
name ↔ String?
The name of the point of grouped nodes shown in the tooltip, dataLabels, etc. By default it is set to '+ n', where n is number of grouped points.
getter/setter pair
pixelHeight ↔ double?
The pixel threshold height of area, which is used in Treemap grouping.
getter/setter pair
pixelWidth ↔ double?
The pixel threshold width of area, which is used in Treemap grouping.
getter/setter pair
reductionFactor ↔ double?
A configuration property that specifies the factor by which the value and size of a grouped node are reduced. This can be particularly useful when a grouped node occupies a disproportionately large portion of the graph, ensuring better visual balance and readability.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited