ZoomCharts Documentation

ZoomCharts.Configuration.ItemsChartSettings

Inheritance hierarchy

This type inherits from BaseSettings.

This type is implemented by GeoChartSettings and NetChartSettings.

Methods

This type does not define any methods.

Properties

Inherited from: BaseSettings
Inherited from: BaseSettings

Chart area related settings.

assetsUrlBase: string
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
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.

Inherited from: BaseSettings

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.

Inherited from: BaseSettings

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: BaseSettingsEvents<ItemsChartChartEventArguments, ItemsChartChartClickEventArguments>
Inherited from: BaseSettings

The events used to handle user interaction with UI elements.

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

Properties
enabled: boolean

Show/hide info popup

linkContentsFunction: (linkData: ItemsChartDataObjectLink, link: ItemsChartLink, asyncCallback: (contents: string) => void) => string

Returns html string to display in passed links info popup.

Parameters

link data

asyncCallback: (contents: string) => void

callback function

Parameters
contents: string
Return value
Data type: string

a HTML string to display in info popup.

nodeContentsFunction: (nodeData: ItemsChartDataObjectNode, node: ItemsChartNode, callback: (contents: string) => void) => string

Returns html string to display in passed nodes info popup.

Parameters

node data

node object

callback: (contents: string) => void

callback function

Parameters
contents: string
Return value
Data type: string

a HTML string to display in info popup.

Inherited from: BaseSettings

Customise chart resize handles or animation duration settings.

Inherited from: BaseSettings

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

Inherited from: BaseSettings

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.

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
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.

Inherited from: BaseSettings

The chart's main title.

Inherited from: BaseSettings

Adjustable settings to manage default and custom toolbar items, as well as toolbar overall appearance.

X