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

ZoomCharts.Configuration.GeoChartAggregationDataObjectNode

Inheritance hierarchy

This type inherits from GeoChartGeoDataObjectNode. Through this type it also inherits members from ItemsChartDataObjectNode, ItemsChartDataObjectBase, BaseDataErrorResponse and BaseDataObjectBase.

Methods

This type does not define any methods.

Properties

aggregate: boolean
This property is deprected; use the automatic proximity based aggregation instead

Marks this node as a result for the grid based aggregation. If this is specified, count must be as well.

aggregatedNodes: Array<GeoChartGeoDataObjectNode>

Contains all original node data objects that have been aggregated into this instance

aggregatedWeight: number
className: string
Inherited from: ItemsChartDataObjectNode
coordinates: [number, number] | Array<Array<number>>

Coordinates can specify a point (for example, [0, 2]) or a shape (an array containing separate polygons, where each polygon is an array of concatenated X/Y coordinate pairs, for example [[0,2,2,2,2,0],[10,10,12,12]])

The first value in the coordinate pair is longitude (east/west) and the second is latitude (north/south).

count: number
This property is deprected; use the automatic proximity based aggregation insted

The count of aggregated nodes within the grid cell. Only used if aggregate is set to true.

error: string
Inherited from: BaseDataErrorResponse

If the data could not be retrieved, this field can be used to instruct the chart to cancel the data request and log an error. Note that in most cases this field should not be used in favor of returning the correct HTTP status code (such as 404 or 500) so that the browser and any proxies do not cache the response.

extra: any
Inherited from: BaseDataObjectBase

Store any additional data values within this field. Although it is possible to extend the data object itself with additional fields it is not recommended to do so because a future ZoomCharts version could introduce a known parameter with the same name thus changing the behavior of an existing chart.

id: string
Inherited from: ItemsChartDataObjectNode

The unique identifier of the node.

loaded: boolean
Inherited from: ItemsChartDataObjectNode

Determines if the node data is complete (when true) or if the data is incomplete and only provided as a placeholder (value false).

In most cases this should be specified as true, the exception being a scenario where another node contains a link to this node, that link is included in the data response but the data for this node is not available so a placeholder is created and the chart will have to issue another data request to load the actual data.

shapeFeature: any
Introduced in version 1.11.2.

If the data object has been generated from GeoJSON, this property will contain the entire feature object from which this data object was created.

shapeGeometry: any
Introduced in version 1.11.2.

If the data object has been generated from GeoJSON, this property will contain the entire geometry object from which this data object was created.

type: string
X