ZoomCharts Documentation

FacetChart.settings.events

This section is defined by the type LinearChartSettingsEvents<FacetChartChartEventArguments, FacetChartChartClickEventArguments>.

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.

onAnimationDone: (event: BaseMouseEvent, args: FacetChartChartEventArguments) => void
Default value: null

Function called when chart scrolling animation is finished.

Parameters

An empty mouse event.

onChartUpdate: (event: BaseMouseEvent, args: FacetChartChartEventArguments) => 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

An empty mouse event.

Default value: null
Inherited from: BaseSettingsEvents

Function called when user clicks on chart.

Parameters

The mouse event.

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

Function called when user double clicks on chart.

Parameters

The mouse event.

Default value: null
Inherited from: BaseSettingsEvents

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

Parameters

The mouse event that was the cause of the error.

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

Function called when object pointer is on changes.

Parameters

The mouse event.

onPositionChange: (event: BaseMouseEvent, args: FacetChartChartEventArguments) => 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

The mouse event that caused the event (if any)

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

Function called when user right clicks on chart.

Parameters

The mouse event.

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

Function called when selected slices has changed.

Parameters

The mouse event.

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

Function called when settings are changed.

Parameters

An empty mouse event.

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

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

Parameters

The mouse event.

X