React Map Methods

|

The Marker object(s).

Return Value:

Promise<Object> (jQuery or native)

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.

addRoute(routeOptions)

Adds a route to the map.

Parameters:

options:

|

The Route object(s).

Return Value:

Promise<Object> (jQuery or native)

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"

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.

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:

rule:

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

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

JavaScript

DevExpress.ui.dxMap.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Map properties
    }
});

Angular

TypeScript

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()

Disposes of all the resources allocated to the Map instance.

After calling this method, remove the DOM element associated with the UI component:

JavaScript

$("#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

app.component.html

<dx-map ...
    *ngIf="condition">
</dx-map>

Vue

App.vue

<template>
    <DxMap ...
        v-if="condition">
    </DxMap>
</template>

<script>
import DxMap from 'devextreme-vue/map';

export default {
    components: {
        DxMap
    }
}
</script>

React

App.js

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.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

focus()

Sets focus on the UI component.

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

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);

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

This UI component's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

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.

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

A 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.

removeMarker(marker)

Removes a marker from the map.

Parameters:

marker:

|

Number

|

The Marker object(s) or an index.

Return Value:

Promise<void> (jQuery or native)

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)

Removes a route from the map.

Parameters:

route:

|

Number

|

The Route object(s) or an index.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after the route is removed. It is a native Promise or a jQuery.Promise when you use jQuery.

repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName: