Vue Map Methods
This section describes members used to manipulate a UI component.
See Also
addMarker(markerOptions)
Adds a marker to the map.
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;
- iconSrc (optional) - a URL pointing to the custom icon to be used for the marker.
See Also
addRoute(routeOptions)
Adds a route to the map.
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
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Map UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxMap.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map properties } });
Angular
import Map, { Properties } from "devextreme/ui/map"; // ... export class AppComponent { constructor () { Map.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the Map properties } }); } }
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 properties } }); export default { components: { DxMap } } </script>
React
import dxMap from "devextreme/ui/map"; import Map from "devextreme-react/map"; dxMap.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Map properties } }); export default function App() { return ( <div> <Map id="map1" /> <Map id="map2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxMap.defaultOptions({ device: deviceConfig, options: { // Here go the Map properties } }); });
Angular
import Map, { Properties } from "devextreme/ui/map"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Map.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the Map properties } }); }); } }
Vue
<template> <div> <DxMap /> </div> </template> <script> import DxMap from "devextreme-vue/map"; import Map from "devextreme/ui/map"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Map.defaultOptions({ device: deviceConfig, options: { // Here go the Map properties } }); }); export default { components: { DxMap } } </script>
React
import dxMap from "devextreme/ui/map"; import Map from "devextreme-react/map"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxMap.defaultOptions({ device: deviceConfig, options: { // Here go the Map properties } }); }); export default function App() { return ( <div> <Map /> </div> ) }
dispose()
Disposes of all the resources allocated to the Map instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myMap").dxMap("dispose"); $("#myMap").remove();
Angular
Use conditional rendering instead of this method:
<dx-map ... *ngIf="condition"> </dx-map>
Vue
Use conditional rendering instead of this method:
<template> <DxMap ... v-if="condition"> </DxMap> </template> <script> import DxMap from 'devextreme-vue/map'; export default { components: { DxMap } } </script>
React
Use conditional rendering instead of this method:
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;
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component 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()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a EventObject 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
removeMarker(marker)
Removes a marker from the map.
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
removeRoute(route)
Removes a route from the map.
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
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.