ZoomCharts Documentation
ZoomCharts.Configuration.NetChartSettings
Inheritance hierarchy
This type inherits from ItemsChartSettings. Through this type it also inherits members from BaseSettings.
Methods
Properties
Chart area related settings.
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.
Contains settings for the auras drawn beneath the nodes.
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.
Settings for displaying chart credits. Use it as a reference to additional data sources if necessery.
Note that even if credits enabled on page load, it's possible to hide on exported images.
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.
The events used to handle user interaction with UI elements.
Configurable conditions to filter the raw data values for subset of drawing nodes and links.
Properties
Determine if link can be displayed. Invoked whenever a link is about to be shown or its data has changed. Only links that have been allowed by nodeFilter for both end nodes will be passed here.
Parameters
link data object
data object representing node where the link begins
data object representing node where the link ends
Return value
true if the link should be shown, false otherwise
Function called whenever there is more than one link between two nodes. Only links that were allowed by nodeFilter, linkFilter and nodeLinksProcessor will be passed here. The function can return either some of the original links, or create completely new links. In the latter case, link IDs MUST be unique (links passed in are guaranteed to have unique IDs).
Parameters
array of link data objects
data object representing node where the links begins
data object representing node where the links ends
Return value
One or more links to be used in place of the original links
Determine if node can be displayed. Invoked whenever a node or one of its links is about to be shown, or if data for the node (or its links) has changed.
Parameters
Node data object
Unfiltered array of link data objects (linkFilter/nodeLinksProcessor/multilinkProcessor have not been applied)
Return value
true if the node should be shown, false otherwise
From links that were allowed by nodeFilter and linkFilter, select the ones that will be displayed. This is basically a bulk version of linkFilter. It is also allowed to return a completely new set of links, however link IDs MUST be unique in this case (links passed in are guaranteed to have unique IDs).
Parameters
Node data object
Array of link data objects. All links are connected to the node. Only links that were allowed by nodeFilter/linkFilter will be passed here. MultilinkProcessor has not been applied yet.
Return value
Array of links to show.
Info popup for item - meaning links or nodes - with configurable content rendered.
Properties
Show/hide info popup
Returns html string to display in passed links info popup.
Parameters
Return value
a HTML string to display in info popup.
Returns html string to display in passed nodes info popup.
Parameters
Return value
a HTML string to display in info popup.
Delay before showing the popup
Whether to show a label if no contents function has been provided
Customise chart resize handles or animation duration settings.
Adjustable settings to get desired net chart layout style and animation while and before interacting.
The chart legend representing classes attached to nodes or links.
The legend will display the visual styles specified in style.nodeClasses and style.linkClasses - by default these are not defined
so the legend will be empty.
Configurable link menu with option to specify a range of displaying buttons.
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.
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
- Example: PieChart within a NetChart
Chart style settings.
See also
- Documentation: NetChart style settings
Theme to apply. You can either use this to share configuration objects between multiple charts or use one of the predefined themes.
See also
- Documentation: Pre-defined themes
The chart's main title.
Adjustable settings to manage default and custom toolbar items, as well as toolbar overall appearance.