HighchartsScatterSeriesClusterOptions class

Options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.

Note: marker clusters module is not working with boost and draggable-points modules.

The marker clusters feature requires the marker-clusters.js file to be loaded, found in the modules directory of the download package, or online at code.highcharts.com/modules/marker-clusters.js.

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

Inheritance

Constructors

HighchartsScatterSeriesClusterOptions.new({bool? allowOverlap, dynamic animation, HighchartsScatterSeriesClusterDataLabelsOptions? dataLabels, bool? drillToCluster, bool? enabled, HighchartsScatterSeriesClusterEventsOptions? events, HighchartsScatterSeriesClusterLayoutAlgorithmOptions? layoutAlgorithm, HighchartsScatterSeriesClusterMarkerOptions? marker, double? minimumClusterSize, HighchartsScatterSeriesClusterStatesOptions? states, List<HighchartsScatterSeriesClusterZonesOptions>? zones})
Options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.

Properties

allowOverlap ↔ bool?
When set to false prevent cluster overlapping - this option works only when layoutAlgorithm.type = "grid".
getter/setter pair
animation ↔ dynamic
Options for the cluster marker animation.
getter/setter pair
dataLabels ↔ HighchartsScatterSeriesClusterDataLabelsOptions?
Options for the cluster data labels.
getter/setter pair
drillToCluster ↔ bool?
Zoom the plot area to the cluster points range when a cluster is clicked.
getter/setter pair
enabled ↔ bool?
Whether to enable the marker-clusters module.
getter/setter pair
events ↔ HighchartsScatterSeriesClusterEventsOptions?
Highcharts Options Widget.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
layoutAlgorithm ↔ HighchartsScatterSeriesClusterLayoutAlgorithmOptions?
Options for layout algorithm. Inside there are options to change the type of the algorithm, gridSize, distance or iterations.
getter/setter pair
marker ↔ HighchartsScatterSeriesClusterMarkerOptions?
Options for the cluster marker.
getter/setter pair
minimumClusterSize ↔ double?
The minimum amount of points to be combined into a cluster. This value has to be greater or equal to 2.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
states ↔ HighchartsScatterSeriesClusterStatesOptions?
Highcharts Options Widget.
getter/setter pair
zones ↔ List<HighchartsScatterSeriesClusterZonesOptions>?
An array defining zones within marker clusters.
getter/setter pair

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