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

class anychart.core.utils.MapInteractivity Improve this Doc

Extends: anychart.core.utils.Interactivity

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

Methods Overview

Specific settings
copyFormat()Copy formatter function.
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.
Interactivity
drag()Enable/disable drag for map.
keyboardZoomAndMove()Keyboard settings
zoomOnDoubleClick()Double click settings
zoomOnMouseWheel()Mouse wheel settings

Methods Description

copyFormat

Getter for the current copy formatter function.

Returns:

function - Copy format function.
See listing
var interactivity = australiaMap.interactivity();
var format = interactivity.copyFormat();
Setter for the copy formatter function.
Learn more about using copyFormat() method.

Params:

NameTypeDescription
valuefunctionFormatter.

Returns:

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

drag

Gets the current dragging value.

Returns:

boolean - The current value.
Allows to use drag for map. Note: Works only with anychart.charts.Map#zoom

Params:

NameTypeDescription
valuebooleanAllows dragging of the map.

Returns:

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

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.MapInteractivity - Self instance for method chaining.

keyboardZoomAndMove

Getter for the keyboard settings.

Returns:

boolean - Keyboard settings.
Allows to use the keyboard to zoom and move.

Params:

NameTypeDefaultDescription
valueboolean
true
Enable or disable the keyboard to zoom and move.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

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.MapInteractivity - 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.MapInteractivity - Self instance for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.

zoomOnDoubleClick

Getter for the double click settings.

Returns:

boolean - Double click settings.
Enables double click zoom.

Params:

NameTypeDefaultDescription
valueboolean
false
Enable or disable double click zoom.

Returns:

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

zoomOnMouseWheel

Getter for the mouse wheel settings.

Returns:

boolean - Mouse wheel settings.
Allows use the mouse wheel to zoom.

Params:

NameTypeDefaultDescription
valueboolean
false
Enable or disable mouse wheel zoom

Returns:

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