Top
You are looking at an outdated 7.8.0 version of this document. Switch to the 7.14.3 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()Remove all listeners.
unlisten()Remove of the listener.
unlistenByKey()Remove of the listener by the key.

Methods Description

hoverMode

Gets the current hover mode.

Returns:

anychart.enums.HoverMode - Returns current hover mode.

Try it:

Sets the hover mode.

Params:

Name Type Description
value anychart.enums.HoverMode | string Hover mode.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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:

selectionMode

Gets the current selection mode.

Returns:

anychart.enums.SelectionMode - Returns current selection mode.

Try it:

Sets the selection mode.

Params:

Name Type Description
value anychart.enums.SelectionMode | string Selection mode.

Returns:

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

Try it:

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:

Name Type Description
value number Spot radius.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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: