Vue Map Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 } }); } }
Vue
<template> <div> <DxMap id="map1" /> <DxMap id="map2" /> </div> </template> <script> import DxMap from "devextreme-vue/map"; import Map from "devextreme/ui/map"; Map.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map options } }); export default { components: { DxMap } } </script>
React
import React from "react"; import dxMap from "devextreme/ui/map"; import Map from "devextreme-react/map"; class App extends React.Component { render () { dxMap.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map options } }) return ( <div> <Map id="map1" /> <Map id="map2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the widget:
$("#myMap").dxMap("dispose"); $("#myMap").remove();
Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-map ... *ngIf="condition"> </dx-map>
Vue
<template> <DxMap ... v-if="condition"> </DxMap> </template> <script> import DxMap from 'devextreme-vue/map'; export default { components: { DxMap } } </script>
React
import React from 'react'; import Map from 'devextreme-react/map'; function DxMap(props) { if (!props.shouldRender) { return null; } return ( <Map ... > </Map> ); } class App extends React.Component { render() { return ( <DxMap shouldRender="condition" /> ); } } export default App;
See Also
element()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
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: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.