Vue Map Methods

This section describes members used to manipulate a UI component.

addMarker(markerOptions)

Adds a marker to the map.

Parameters:

markerOptions:

Object

|

Array<Object>

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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

addRoute(routeOptions)

Adds a route to the map.

Parameters:

options:

Object

|

Array<Object>

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"

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

defaultOptions(rule)

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

Parameters:

rule:

Object

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Function	Device parameters. When you specify 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

|

Function

Device parameters.
When you specify 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.

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, { 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

JavaScript

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxMap.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the Map properties
        }
    });
});

Angular

TypeScript

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:

JavaScript

$("#myMap").dxMap("dispose");
$("#myMap").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

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

Vue

Use conditional rendering instead of this method:

App.vue

<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:

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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus()

Sets focus on the UI component.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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:

Object

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