JavaScript/jQuery Map Methods
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
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
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
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 from "devextreme/ui/map";
// ...
export class AppComponent {
constructor () {
Map.defaultOptions({
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 React, {useEffect} from "react";
import dxMap from "devextreme/ui/map";
import Map from "devextreme-react/map";
export default function App() {
useEffect(() => {
dxMap.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Map properties
}
})
});
return (
<div>
<Map id="map1" />
<Map id="map2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myMap").dxMap("dispose");
$("#myMap").remove();Use this method only if the UI component 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
getInstance(element)
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
registerKeyHandler(key, handler)
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)
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.