ZoomCharts Documentation
Version: 1.21.1 (2024-11-08)

GeoChart.settings.layerTypes.items.aggregation

This section is defined by the type GeoChartSettingsAggregation.

Controls automatic proximity based aggregation.

Properties

distance: number
Default value: 60

The approximate minimum distance in pixels between two nodes before they are aggregated together.

enabled: boolean
Default value: false

Enables/Disables automatic aggregation

ignoreZeroWeight: boolean
Default value: false
Introduced in version 1.17.0.

Specifies if nodes where the weightFunction returns 0 are completely ignored by the aggregation. This means that they are not drawn in the convex shape and also are not present in the aggregatedNodes property.

maxZoom: number
Default value: 18

The last zoom level on which the nodes are automatically agregated. When the chart is zoomed in deeper, the original nodes will be used instead.

postProcessAggregatedNodes: (nodes: Array<GeoChartAggregationDataObjectNode>, map: Dictionary<GeoChartAggregationDataObjectNode>, modifiedNodes: Array<GeoChartAggregationDataObjectNode>) => void
Experimental property - the API might not be stable and is subject to change.

A delegate that can be used to process aggregated nodes before links are aggregated. The delegate should modify the given array and mapping information if some nodes should be aggregated differently.

Parameters
nodes: Array<GeoChartAggregationDataObjectNode>

The aggregated node objects.

map: Dictionary<GeoChartAggregationDataObjectNode>

A dictionary that maps the original node ID to the aggregated node (the same instance that is present in the nodes array).

modifiedNodes: Array<GeoChartAggregationDataObjectNode>

An empty array that the delegate is expected to fill with aggregated nodes that have been modified.

shouldCentralize: boolean
Default value: false

If true, aggregated nodes are placed in the center of mass of all the underlying nodes, even if no actual underlying node is at that location. Otherwise, aggregated nodes are placed at the location of a single real "representative" node.

weightFunction: (node: GeoChartGeoDataObjectNode) => number
Default value: null

Function that returns the value used as weight in the aggregation process for each node.

Parameters
Return value
Data type: number
X