AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.utils.MapInteractivity Improve this Doc

Methods Overview

Specific settings
copyFormat()Copy formatter function.
hoverMode()Hover mode.
multiSelectOnClick()Multi-select on click settings.
selectionMode()Selection mode.
spotRadius()Spot radius.
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
drag()Enable/disable drag for map.
keyboardZoomAndMove()Keyboard settings.
zoomOnDoubleClick()Double click settings.
zoomOnMouseWheel()Mouse wheel settings.

Methods Description

copyFormat

Getter for the 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
formatFunctionfunctionFormatter.

Returns:

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

drag

Getter for the dragging value.

Returns:

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

Params:

NameTypeDescription
enabledbooleanAllows dragging of the map.

Returns:

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

hoverMode

Getter for the hover mode.

Returns:

anychart.enums.HoverMode | string - Hover mode.
Setter for the hover mode.

Params:

NameTypeDescription
modeanychart.enums.HoverMode | stringHover mode to set.

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
enabledboolean
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(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.MapInteractivity - 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.

selectionMode

Getter for the selection mode.

Returns:

anychart.enums.SelectionMode | string - Returns selection mode.
Setter for the selection mode.

Params:

NameTypeDescription
modeanychart.enums.SelectionMode | stringSelection mode to set.

Returns:

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

spotRadius

Getter for the spot radius.

Returns:

number - Returns spot radius.
Setter for the spot radius. Size of the area under cursor in pixels for radius hovering. Note: Works only with "by-spot" value in the anychart.core.utils.Interactivity#hoverMode method.

Params:

NameTypeDescription
radiusnumberSpot radius to set.

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

zoomOnDoubleClick

Getter for the double click settings.

Returns:

boolean - Double click settings.
Enables double click zoom.

Params:

NameTypeDefaultDescription
enabledboolean
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
enabledboolean
false
Enable or disable mouse wheel zoom

Returns:

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