class anychart.core.utils.MapInteractivity Improve this Doc
Extends: anychart.core.utils.Interactivity
Interactivity class for maps.
Learn more about the map interactivity.
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. |
| 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.
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 |
|---|---|---|
| formatFunction | 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 |
|---|---|---|
| enabled | boolean | Allows dragging of the map. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
hoverMode
Setter for the hover mode.
Params:
| Name | Type | Description |
|---|---|---|
| mode | anychart.enums.HoverMode | string | Hover mode to set. |
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 |
|---|---|---|---|
| enabled | boolean | true | Enable or disable the keyboard to zoom and move. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enable/disable multi select on click. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
selectionMode
Getter for the selection mode.
Returns:
anychart.enums.SelectionMode | string - Returns selection mode.Try it:
Setter for the selection mode.
Params:
| Name | Type | Description |
|---|---|---|
| mode | anychart.enums.SelectionMode | string | Selection mode to set. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| radius | number | Spot radius to set. |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it:
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.
If the value is true, disables select all points when clicking outside the chart point.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | 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.Try it:
zoomOnDoubleClick
Enables double click zoom.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | 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 |
|---|---|---|---|
| enabled | boolean | false | Enable or disable mouse wheel zoom |
Returns:
anychart.core.utils.MapInteractivity - Self instance for method chaining.Try it: