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.
Learn more about using copyFormat() method.
Detailed description
Data formatter for feature copy operation.
To see result, select feature on the map, push on CTRL+C, paste the text to anywhere.
Params:
| Name | Type | Description |
|---|---|---|
| value | function | Formatter. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
drag
Allows to use drag for map.
Note: Works only with anychart.charts.Map#zoom
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Allows dragging of the map. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
hoverMode
Sets the hover mode.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.HoverMode | string | Hover mode. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
keyboardZoomAndMove
Allows to use the keyboard to zoom and move.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true | Enable or disable the keyboard to zoom and move. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
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:
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.MapInteractivity - 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.MapInteractivity - 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:
zoomOnDoubleClick
Enables double click zoom.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Enable or disable double click zoom. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
zoomOnMouseWheel
Allows use the mouse wheel to zoom.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Enable or disable mouse wheel zoom |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it: