JavaScript/jQuery VectorMap Methods

The current map center coordinates.

This method returns the center coordinates as an array of two values in the [longitude, latitude] format.

center(centerCoordinates)

Sets the map center coordinates.

Parameters:

centerCoordinates:

New map center coordinates. Pass null to reset the coordinates.

To change the coordinates of the map center, pass an array of two values in the [longitude, latitude] form as the argument to the center(centerCoordinates) method.

In addition, you can get the current coordinates of the map center by calling the same method without arguments. Moreover, you can perform specific actions when the center coordinates are changed. For this purpose, implement a callback function and assign it to the onCenterChanged property.

clearSelection()

Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after.

convertCoordinates(x, y)

Use the convertToGeo(x_y) method instead.

Converts client area coordinates into map coordinates.

Parameters:

x:

An X coordinate of the client area.

y:

An Y coordinate of the client area.

Return Value:

Map coordinates.

convertToGeo(x, y)

Converts coordinates from pixels to the dataSource coordinate system.

Parameters:

x:

The X coordinate of the client area.

y:

The Y coordinate of the client area.

Return Value:

Two coordinates that represent the point in the dataSource coordinate system.

convertToXY(longitude, latitude)

Converts coordinates from the dataSource coordinate system to pixels.

Parameters:

longitude:

A point's longitude.

latitude:

A point's latitude.

Return Value:

The point's coordinates in the client area coordinate system.

dispose()

Disposes of all the resources allocated to the VectorMap instance.

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

JavaScript

$("#myVectorMap").dxVectorMap("dispose");
$("#myVectorMap").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-vector-map ...
    *ngIf="condition">
</dx-vector-map>

Vue

App.vue

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

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

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

React

App.js

import React from 'react';

import VectorMap from 'devextreme-react/vector-map';

function DxVectorMap(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <VectorMap ... >    
        </VectorMap>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxVectorMap 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()

exportTo(fileName, format)

Exports the UI component.

Parameters:

fileName:

The name of the file to which the UI component is about to be exported.

format:

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

getInstance(element)

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

Parameters:

element:

DOM Node

|

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 VectorMap instance found in an element with the myVectorMap ID:

// Modular approach
import VectorMap from "devextreme/viz/vector_map";
...
let element = document.getElementById("myVectorMap");
let instance = VectorMap.getInstance(element) as VectorMap;

// Non-modular approach
let element = document.getElementById("myVectorMap");
let instance = DevExpress.viz.dxVectorMap.getInstance(element);

getLayerByIndex(index)

Gets a layer with a specific index.

Parameters:

index:

The index in the layers array.

Return Value:

Layer Element

The Layer object.

getLayerByName(name)

Gets a layer with a specific name.

Parameters:

name:

The layer's name.

Return Value:

Layer Element

The Layer object.

getLayers()

Gets all layers.

Return Value:

Array<Layer Element>

The Layer objects.

getSize()

Gets the current UI component size.

Return Value:

Size

The current UI component size.

Returns an object with the following fields.

width
The width of the UI component in pixels.
height
The height of the UI component in pixels.

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the UI component is ready, you can hide it from code at the required moment using this method.

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:

Function

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:

Function

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.

print()

Opens the browser's print window.

render()

Redraws the UI component.

Normally, the UI component redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the UI component's container is resized. For this purpose, call the render() method.

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName:

A property's name.

showLoadingIndicator()

Shows the loading indicator.

svg()

Gets the UI component's SVG markup.

Return Value:

The UI component's SVG markup.

viewport()

Gets the current map viewport coordinates.

Return Value:

The viewport coordinates.

This method returns the viewport coordinates as an array of four values in the [minLongitude, maxLatitude, maxLongitude, minLatitude] form.

viewport(viewportCoordinates)

Sets the map viewport coordinates.

Parameters:

viewportCoordinates:

New viewport coordinates. Pass null to reset the viewport.

To change the coordinates of the map viewport, pass an array of four values in the [minLongitude, maxLatitude, maxLongitude, minLatitude] form as the argument to the viewport(viewportCoordinates) method. If the passed coordinates do not fit the aspect ratio of the UI component container precisely, either the latitude or longitude will be applied depending on the largest range.

In addition, you can get the current coordinates of the map viewport by calling the same method without arguments.

If you have implemented the onCenterChanged or onZoomFactorChanged callback functions, they will be triggered when the viewport coordinates are changed using the viewport(viewportCoordinates) method.

zoomFactor()

Gets the current zoom factor value.

Return Value:

The zoom factor value.

zoomFactor(zoomFactor)

Sets the zoom factor value.

Parameters:

zoomFactor: