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

GeoChart.settings.data

This section is defined by the type GeoChartSettingsData.

Properties

aggregationGridSize: number
Default value: 100
This property is deprected; use the automatic proximity based aggregation instead

Specifies the size of the grid that is included in the request.

aggregationMinCount: number
Default value: 5
This property is deprected; use the automatic proximity based aggregation instead

The value will be passed to the data request together with the aggregation grid data.

bounds: [number, number, number, number]
Default value: [-180, -85.0511287798, 180, 85.0511287798]
cacheSize: number
Default value: 10000
Inherited from: ItemsChartSettingsData

Count of caching items including only links and nodes.

dataFunction: (request: GeoChartDataRequest, success: (data: GeoChartDataObject) => void, fail: (result: BaseDataErrorResponse) => void) => void
Default value: null
Parameters
success: (data: GeoChartDataObject) => void
Parameters
fail: (result: BaseDataErrorResponse) => void
Parameters
format: "JSON" | "GeoJSON"
Default value: "JSON"
Inherited from: BaseSettingsData

Data loading format. Currently most charts only support JSON.

id: string
Default value: "default"
Inherited from: BaseSettingsData

Data id used for series to reference specific data source.

maxRequestRect: [number, number]
Default value: [256, 256]
numberOfParallelRequests: number
Default value: 3
Inherited from: BaseSettingsData

Max number of parallel data requests to issue. More requests will result in faster loading, but might put heavy load on server.

perBoundsData: boolean
Default value: true

If true, data source will use bounds to limit response, if false, assume all data is returned.

perDrilldownData: boolean
Default value: false

If true, separate data is requested at each drilldown level.

perZoomData: boolean
Default value: false

If true, separate data is requested at each zoom level.

postprocessorFunction: (data: string) => string
Default value: null
Inherited from: BaseSettingsData

Delegate that can be used to process data returned by the server for the HTTP request issued by the chart.

Parameters
data: string

The raw data received from the server.

Return value
Data type: string

The data object that will be further processed by the chart.

prefetchRatio: number
Default value: 1
preloaded: GeoChartDataObject
Inherited from: BaseSettingsData
Version 1.12.0: the value has to be an object, JSON strings are no longer accepted.

Provides the ability to embed chart data directly into the chart configuration.

This data can be complete or act as the initial data where the rest will be requested dynamically using url or dataFunction.

random: "grid" | "tree" | "uniform"
Default value: null
Inherited from: ItemsChartSettingsData

Specifies the random layout method: grid, tree, uniform. The default is uniform.

Valid values:
  • grid
  • tree
  • uniform
randomGridLinkProbability: number
Default value: 0.6
Inherited from: ItemsChartSettingsData
randomNodes: number
Default value: 0
Inherited from: ItemsChartSettingsData

Generates random data. Specify a value larger than 0 to enable generating random data.

randomTreeDensity: number
Default value: 3
Inherited from: ItemsChartSettingsData
requestMaxUnits: number
Default value: 2
Inherited from: ItemsChartSettingsData

Max number of nodes to submit in a single request.

requestTimeout: number
Default value: 40000
Inherited from: BaseSettingsData

Timeout in milliseconds for data requests. This timeout only applies to HTTP requests issued by the chart directly.

url: string
Default value: null
Inherited from: BaseSettingsData

URL that is used to load data

urlParameters: Array<{ name?: string; value?: string; }>
Inherited from: BaseSettingsData

List of extra parameters to pass with data URL.

Properties
name: string

Parameter name.

value: string

Parameter value.

useGridBasedAggregation: boolean
Default value: false
This property is deprected; use the automatic proximity based aggregation instead
Version 1.12.0: The setting was added. Previously the perBoundsData had to be true for the grid to be included.

If true, the data request will include the coordinates for the aggregation grid.

wrapLng: boolean
Default value: true
X