AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.utils.Interactivity Improve this Doc

Extends: anychart.core.Base

Class is settings for interactivity (like hover, select).

Methods Overview

Specific settings
hoverMode()Hover mode.
selectionMode()Selection mode.
spotRadius()Spot radius.
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.

Methods Description

hoverMode

Gets the current hover mode.

Returns:

anychart.enums.HoverMode - Current hover mode.
Sets the hover mode.

Params:

NameTypeDescription
valueanychart.enums.HoverMode | stringHover mode.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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.

selectionMode

Gets the current selection mode.

Returns:

anychart.enums.SelectionMode - Returns current selection mode.
Sets the selection mode.

Params:

NameTypeDescription
valueanychart.enums.SelectionMode | stringSelection mode.

Returns:

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

spotRadius

Gets the current spot radius.

Returns:

number - Returns current spot radius.
Sets the spot radius. Size of the area under cursor in pixels for radius hovering.

Params:

NameTypeDescription
valuenumberSpot radius.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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.