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:

Name Type Default Description
type string
The event type id.
listener function
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 }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

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:

Name Type Default Description
value boolean
true
Enable/disable multi select on click.

Returns:

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

Try it:

removeAllListeners

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

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

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:

Name Type Default Description
value boolean
true
Whether will use mouse wheel.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

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:

Name Type Default Description
value boolean
value for Pie chart is false, for other chart types is true
Enable/disable unselect on click.

Returns:

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

Try it:

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. Press "ctrl" or "shift" and zoom mouse wheel.

Params:

Name Type Default Description
value boolean
true
Whether will use mouse wheel.

Returns:

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

Try it: