Map
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
| autoAdjust |
Specifies whether the widget automatically adjusts center and zoom option values when adding a new marker or route, or if a new widget contains markers or routes by default. |
| center |
An object, a string, or an array specifying which part of the map is displayed at the widget's center using coordinates. The widget can change this value if autoAdjust is enabled. |
| controls |
Specifies whether or not map widget controls are available. |
| disabled |
Specifies whether the widget responds to user interaction. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| key |
A key used to authenticate the application within the required map provider. |
| markerIconSrc |
A URL pointing to the custom icon to be used for map markers. |
| markers |
An array of markers displayed on a map. |
| onClick |
A function that is executed when any location on the map is clicked or tapped. |
| onDisposing |
A function that is executed before the widget is disposed of. |
| onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
| onMarkerAdded |
A function that is executed when a marker is created on the map. |
| onMarkerRemoved |
A function that is executed when a marker is removed from the map. |
| onOptionChanged |
A function that is executed after a widget option is changed. |
| onReady |
A function that is executed when the map is ready. |
| onRouteAdded |
A function that is executed when a route is created on the map. |
| onRouteRemoved |
A function that is executed when a route is removed from the map. |
| provider |
The name of the current map data provider. |
| routes |
An array of routes shown on the map. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| type |
The type of a map to display. |
| visible |
Specifies whether the widget is visible. |
| width |
Specifies the widget's width. |
| zoom |
The map's zoom level. The widget can change this value if autoAdjust is enabled. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
| Name | Description |
|---|---|
| addMarker(markerOptions) |
Adds a marker to the map. |
| addRoute(routeOptions) |
Adds a route to the map. |
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the Map instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| removeMarker(marker) |
Removes a marker from the map. |
| removeRoute(route) |
Removes a route from the map. |
| repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
| Name | Description |
|---|---|
| click |
Raised when any location on the map is clicked. |
| disposing |
Raised before the widget is disposed of. |
| initialized |
Raised only once, after the widget is initialized. |
| markerAdded |
Raised when a marker is created on the map. |
| markerRemoved |
Raised when a marker is removed from the map. |
| optionChanged |
Raised after a widget option is changed. |
| ready |
Raised when the map is ready. |
| routeAdded |
Raised when a route is created on the map. |
| routeRemoved |
Raised when a route is removed from the map. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core