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

NetChart.settings.events

This section is defined by the type NetChartSettingsEvents.

The events used to handle user interaction with UI elements.

Properties

chartUpdateDelay: number
Default value: 0
Inherited from: BaseSettingsEvents

Function called on pointer down. Function called on pointer up. Function called when pointer drag has happened. Function called when mouse pointer is moved. Function called when data is loaded/added/replaced/removed. Time to wait after last action before firing onChartUpdate event.

onChartUpdate: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when whenever current view has changed. Usually after panning and navigation. Use to update any linked views. Note that this is also fired after chart initialization and API methods. Use args.origin field to determine event's origin.

Parameters
event: BaseMouseEvent

An empty mouse event.

onClick: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when user clicks on chart.

Parameters
event: BaseMouseEvent

The mouse event.

onDataUpdated: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null

Function called when data is loaded/added/replaced/removed.

Parameters
event: BaseMouseEvent

An empty mouse event.

onDoubleClick: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when user double clicks on chart.

Parameters
event: BaseMouseEvent

The mouse event.

onError: (event: BaseMouseEvent, args: BaseChartErrorEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when error occurs, default behavior is log to console.

Parameters
event: BaseMouseEvent

The mouse event that was the cause of the error.

onHoverChange: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when object pointer is on changes.

Parameters
event: BaseMouseEvent

The mouse event.

onLassoChange: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when lasso is changed

Parameters
event: BaseMouseEvent

The mouse event that caused the event (if any)

onLongPress: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when user long presses on chart.

Parameters
event: BaseMouseEvent

The mouse event.

onPointerDown: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Parameters
event: BaseMouseEvent

The mouse event.

onPointerDrag: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null

Function called when pointer drag has happened.

Parameters
event: BaseMouseEvent

The mouse event.

onPointerMove: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null

Function called when mouse pointer is moved.

Parameters
event: BaseMouseEvent

The mouse event.

onPointerUp: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null

Function called on pointer up.

Parameters
event: BaseMouseEvent

The mouse event.

onPositionChange: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called whenever chart placement on screen changes. Note that this is called on every animation frame and is intended for painting overlays only.

Parameters
event: BaseMouseEvent

The mouse event that caused the event (if any)

onRightClick: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when user right clicks on chart.

Parameters
event: BaseMouseEvent

The mouse event.

onSelectionChange: (event: BaseMouseEvent, args: NetChartChartEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when selected slices has changed.

Parameters
event: BaseMouseEvent

The mouse event.

onSettingsChange: (event: BaseMouseEvent, args: BaseChartSettingsChangeEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when settings are changed.

Parameters
event: BaseMouseEvent

An empty mouse event.

onTripleClick: (event: BaseMouseEvent, args: NetChartChartClickEventArguments) => void
Default value: null
Inherited from: BaseSettingsEvents

Function called when user triple clicks on chart. Use it for custom function call.

Parameters
event: BaseMouseEvent

The mouse event.

X