addMarker(markerOptions)
A Promise that is resolved with an original marker instance when the marker is added. It is a native Promise or a jQuery.Promise when you use jQuery.
The marker object should include the following fields.
- location (required) - the marker location. You can specify the location in one of the following formats:
- { lat: 40.749825, lng: -73.987963};
- "40.749825, -73.987963";
- [40.749825, -73.987963];
- 'Brooklyn Bridge,New York,NY';
- tooltip (optional) - the marker tooltip;
- onClick (optional) - a callback function performed when the marker is clicked;
- text (optional) - the marker caption.
- iconSrc (optional) - a URL pointing to the custom icon to be used for the marker.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
addRoute(routeOptions)
A Promise that is resolved with an original route instance when the route is added. It is a native Promise or a jQuery.Promise when you use jQuery.
The route object should include the locations field, containing an array of route locations. Each location can be specified in any of the following formats.
- { lat: 40.749825, lng: -73.987963}
- "40.749825, -73.987963"
- [40.749825, -73.987963]
- 'Brooklyn Bridge,New York,NY'
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
defaultOptions(rule)
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Map widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxMap.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map options } });
Angular
import Map from 'devextreme/ui/map'; // ... export class AppComponent { constructor () { Map.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map options } }); } }
dispose()
The following code disposes of an Map instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myMap").dxMap("dispose"); $("#myMap").remove();
Angular
<dx-map #mapVar id="myMap"></dx-map>
import { ..., ViewChild } from "@angular/core"; import { DxMapComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("mapVar") map: DxMapComponent; removeMap (e) { this.map.instance.dispose(); document.getElementById("myMap").remove(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
getInstance(element)
getInstance is a static method that the widget class supports. The following code demonstrates how to get the Map instance found in an element with the myMap
ID:
// Modular approach import Map from 'devextreme/ui/map'; ... let element = document.getElementById("myMap"); let instance = Map.getInstance(element) as Map; // Non-modular approach let element = document.getElementById("myMap"); let instance = DevExpress.ui.dxMap.getInstance(element);
See Also
registerKeyHandler(key, handler)
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
removeMarker(marker)
A Promise that is resolved after the marker is removed. It is a native Promise or a jQuery.Promise when you use jQuery.
removeRoute(route)
A Promise that is resolved after the route is removed. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.