AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.utils.StockInteractivity Improve this Doc

Extends: anychart.core.utils.Interactivity

Interactivity class for stocks.

Methods Overview

Specific settings
multiSelectOnClick()Multi-select on click settings.
unselectOnClickOutOfPoint()Unselect on click settings.
Events
listen()Adds an event listener
listenOnce()Adds a single time event listener
removeAllListeners()Removes all listeners
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key
Interactivity
scrollOnMouseWheel()Interactivity scrolling settings.
zoomOnMouseWheel()Interactivity zoom settings.

Methods Description

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

multiSelectOnClick

Getter for the multi-select on click.

Returns:

boolean - Return enable/disable state.
See listing
var interactivity = chart.interactivity();
var multiSelectOnClick = interactivity.multiSelectOnClick();
Setter for the multi-select on click.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enable/disable multi select on click.

Returns:

anychart.core.utils.StockInteractivity - Self instance for method chaining.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

scrollOnMouseWheel

Getter for the scrolling.

Returns:

boolean - Whether will use mouse wheel.
See listing
var scrollOnMouseWheel = interactivity.scrollOnMouseWheel();
Setter for the scrolling.
Allows use mouse wheel for scrolling. Press "ctrl" or "shift" and scroll mouse wheel.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether will use mouse wheel.

Returns:

anychart.core.utils.StockInteractivity - Self instance for method chaining

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

unselectOnClickOutOfPoint

Getter for the unselectOnClickOutOfPoint.

Returns:

boolean - Return enable/disable state.
Setter for the unselectOnClickOutOfPoint.
If the value is true, disables select all points when clicking outside the chart point.

Params:

NameTypeDefaultDescription
enabledboolean
value for Pie chart is false, for other chart types is true
Enable/disable unselect on click.

Returns:

anychart.core.utils.StockInteractivity - Self instance for method chaining.

zoomOnMouseWheel

Getter for the zoom.

Returns:

boolean - Whether will use mouse wheel.
See listing
var zoomOnMouseWheel = interactivity.zoomOnMouseWheel();
Setter for the zoom.
Allows use mouse wheel for zooming.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether will use mouse wheel.

Returns:

anychart.core.utils.StockInteractivity - Self instance for method chaining.