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

ZoomCharts.Configuration.GeoChartSettingsLayerAggregated

Inheritance hierarchy

This type inherits from GeoChartSettingsLayerOverlay. Through this type it also inherits members from GeoChartSettingsLayerBase.

Methods

This type does not define any methods.

Properties

aggregation: "sum" | "min" | "max" | "first" | "last" | "avg" | "count"

Aggregation function to use.

Valid values:
  • sum
  • min
  • max
  • first
  • last
  • avg
  • count
aggregationField: string

Data field used for aggregation.

aggregationFunction: (nodesArray: Array<GeoChartGeoDataObjectNode>) => number

Custom function to call for aggregation

Parameters
nodesArray: Array<GeoChartGeoDataObjectNode>

array of nodes matching single shape

Return value
Data type: number

aggregated value, to be passed to styleFunction

data: anonymous type
Properties
id: string
enabled: boolean
id: string
maxZoom: number
minZoom: number
name: string
perZoomStyle: boolean

Forces style re-evaluation on zoom change. Use to provide zoom dependant style.

shapesLayer: string

The ID of a linked shapes layer. Style changes will be applied to this layer. The shapes layer must be defined before the aggregation layer.

styleFunction: (node: ItemsChartNode, value: number) => void

Function for applying the aggregated value on node.

Parameters
node: ItemsChartNode

shape node style is being applied to

value: number

computed aggregate value

type: "shapes" | "items" | "charts" | "aggregateOnShapes"
Valid values:
  • shapes
  • items
  • charts
  • aggregateOnShapes
useFindObjectHack: boolean
X