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

GeoChart.settings

This section is defined by the type GeoChartSettings.

Properties

area: GeoChartSettingsArea
Inherited from: BaseSettings
View section details

Chart area related settings.

assetsUrlBase: string
Default value: ""
Inherited from: BaseSettings

The URL root where the ZoomCharts library and assets are located. For example, if the base.css file is available at 'http://server/css/zoomcharts/zc.css' then this value should be set to 'http://server/css/zoomcharts/'. Note that the library will try to determine its location automatically by searching the included script tags. So this property can be skipped if the assets folder is located next to 'zoomcharts.js' file on the server.

container: string | HTMLElement
Default value: null
Inherited from: BaseSettings

Element of the page where the chart will be inserted. Any HTML element should work, for example you can use a <div>.

Any contents of the element will be cleared - this behavior can be used to specify a loading message as the initial content, for example <div>Chart is being initialized...</div>.

Note that a single element can host only one chart. If the same container is given to another chart, the previous chart will be automatically disposed.

Unless parentChart is specified, the value of the property is mandatory and can only be specified while creating the chart, not with updateSettings. The value can be either an ID of an existing element or a reference to a DOM element.

credits: BaseSettingsCredits
Inherited from: BaseSettings
View section details

Settings for displaying chart credits. Use it as a reference to additional data sources if necessery.

Chart including credits

Note that even if credits enabled on page load, it's possible to hide on exported images.

data: Array<GeoChartSettingsData>
Default value: [ { "id": "default", "url": null, "urlParameters": [], "postprocessorFunction": null, "preloaded": null, "format": "JSON", "requestTimeout": 40000, "numberOfParallelRequests": 3, "cacheSize": 10000, "random": null, "randomGridLinkProbability": 0.6, "randomNodes": 0, "randomLinks": 0, "randomTreeDensity": 3, "requestMaxUnits": 2, "dataFunction": null, "prefetchRatio": 1, "bounds": [ -180, -85.0511287798, 180, 85.0511287798 ], "wrapLng": true, "maxRequestRect": [ 256, 256 ], "perBoundsData": true, "perZoomData": false, "perDrilldownData": false, "useGridBasedAggregation": false, "aggregationGridSize": 100, "aggregationMinCount": 5 } ]
Inherited from: BaseSettings
View section details

Settings used to load data into chart. Customise preferred data source feeding methods. You can use one of these options: url, data function, preloaded data.

events: GeoChartSettingsEvents
Inherited from: BaseSettings
View section details

The events used to handle user interaction with UI elements.

filters: anonymous type
Properties
nodeFilter: (node: GeoChartGeoDataObjectNode) => boolean
Default value: null
Parameters
Return value
Data type: boolean
info: anonymous type
Inherited from: ItemsChartSettings

Info popup for item - meaning links or nodes - with configurable content rendered.

Properties
enabled: boolean
Default value: false

Show/hide info popup

linkContentsFunction: (linkData: ItemsChartDataObjectLink, link: ItemsChartLink, asyncCallback: (contents: string | HTMLElement) => void) => string | HTMLElement
Default value: null

Returns html string to display in passed links info popup.

Parameters
linkData: ItemsChartDataObjectLink

link data

asyncCallback: (contents: string | HTMLElement) => void

callback function

Parameters
contents: string | string | HTMLElement
Return value
Data type: string | string | HTMLElement

a HTML string to display in info popup.

nodeContentsFunction: (nodeData: ItemsChartDataObjectNode, node: ItemsChartNode, callback: (contents: string | HTMLElement) => void) => string | HTMLElement
Default value: null

Returns html string to display in passed nodes info popup.

Parameters
nodeData: ItemsChartDataObjectNode

node data

node: ItemsChartNode

node object

callback: (contents: string | HTMLElement) => void

callback function

Parameters
contents: string | string | HTMLElement
Return value
Data type: string | string | HTMLElement

a HTML string to display in info popup.

showDelay: number
Default value: 0

Delay before showing the popup

showLabelByDefault: boolean
Default value: true

Whether to show a label if no contents function has been provided

interaction: GeoChartSettingsInteraction
Inherited from: BaseSettings
View section details

Customise chart resize handles or animation duration settings.

layerTypes: anonymous type

The default values for specific layer types. Any custom values in specified in layers property will be applied on top of the values specified here, based on the type property witin them.

Properties
layers: Array<GeoChartSettingsLayerBase>
Default value: []
View section details

An array of objects. Have a look at "layerTypes" for the possible object types

layersDefault: GeoChartSettingsLayerBase
This section is no longer used, specify the defaults in `layerTypes` section, based on the appropriate layer type.
View section details

Specifies the defaults for all layers, independent of the layer type.

linkMenu: ItemsChartSettingsLinkMenu
Inherited from: ItemsChartSettings
View section details

Configurable link menu with option to specify a range of displaying buttons.

localization: BaseSettingsLocalization
Inherited from: BaseSettings
View section details

Localizeable strings including export type options and useful default buttons used for chart interaction. Buttons like to navigate back, set the chart on full screen and others.

navigation: anonymous type
Properties
drilldownLayer: string
Default value: "default"
initialDrilldown: Array<string>
Default value: [ "" ]
initialLat: number
Default value: 40

Specify latitude of the initial center coordinate (WGS-84 degrees)

initialLng: number
Default value: 25

Specify longitude of the initial center coordinate (WGS-84 degrees)

initialZoom: number
Default value: 3

Specify the initial zoom level for the chart. (For most chart data sources, valid values are 0..18 inclusive).

maxBounds: anonymous type
Properties
east: number
Default value: 200
north: number
Default value: -85
south: number
Default value: 85
west: number
Default value: -200
maxZoom: number
Default value: 18
minZoom: number
Default value: 0
nodeMenu: ItemsChartSettingsNodeMenu
Inherited from: ItemsChartSettings
View section details

Configurable node menu with option to specify a range of displaying buttons.

parentChart: BaseApi
Inherited from: BaseSettings

The parent chart within which the new chart will be rendered. If this property is specified, container cannot be specified.

Use area.left, area.top, area.width and area.height settings to position the subchart within parent chart.

See also
style: anonymous type
Inherited from: ItemsChartSettings
Properties
fadeTime: number
Default value: 200
selection: anonymous type
Properties
fillColor: string
Default value: "rgba(200, 200, 255 ,0.7)"
sizeConstant: number
Default value: 5
sizeProportional: number
Default value: 0.2
theme: GeoChartSettings
Default value: { "advanced": { "themeCSSClass": "DVSL-flat" } }
Inherited from: BaseSettings

Theme to apply. You can either use this to share configuration objects between multiple charts or use one of the predefined themes.

See also
title: BaseSettingsTitle
Inherited from: BaseSettings
View section details

The chart's main title.

toolbar: BaseSettingsToolbar
Inherited from: BaseSettings
deprecated
View section details

Please note that currently toolbar is not supported on GeoChart.

X