A newer version of this page is available. Switch to the current version.

JavaScript/jQuery VectorMap Methods

This section describes the methods that can be used in code to manipulate objects related to the UI component.

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

center()

Gets the current map center coordinates.

Return Value:

Array<Number>

The current map center coordinates.

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

View Demo

See Also

center(centerCoordinates)

Sets the map center coordinates.

Parameters:
centerCoordinates:

Array<Number>

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.

View Demo

See Also

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

Use the convertToGeo(x_y) method instead.

Converts client area coordinates into map coordinates.

Parameters:
x:

Number

An X coordinate of the client area.

y:

Number

An Y coordinate of the client area.

Return Value:

Array<Number>

Map coordinates.

convertToGeo(x, y)

Converts coordinates from pixels to the dataSource coordinate system.

Parameters:
x:

Number

The X coordinate of the client area.

y:

Number

The Y coordinate of the client area.

Return Value:

Array<Number>

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

See Also

convertToXY(longitude, latitude)

Converts coordinates from the dataSource coordinate system to pixels.

Parameters:
longitude:

Number

A point's longitude.

latitude:

Number

A point's latitude.

Return Value:

Array<Number>

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

See Also

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;
See Also

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the UI component.

Parameters:
fileName:

String

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

format:

String

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:

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

getLayerByIndex(index)

Gets a layer with a specific index.

Parameters:
index:

Number

The index in the layers array.

Return Value:

Layer Element

The Layer object.

See Also

getLayerByName(name)

Gets a layer with a specific name.

Parameters:
name:

String

The layer's name.

Return Value:

Layer Element

The Layer object.

See Also

getLayers()

Gets all layers.

Return Value:

Array<Layer Element>

The Layer objects.

See Also

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.
See Also

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.

See Also

instance()

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

Return Value:

VectorMap

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

VectorMap

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

VectorMap

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

VectorMap

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.

Parameters:
events:

Object

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

Return Value:

VectorMap

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

Return Value:

Object

The UI component's properties.

See Also

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

See Also

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.

See Also

resetOption(optionName)

Resets a property to its default value.

Parameters:
optionName:

String

A property's name.

See Also

showLoadingIndicator()

Shows the loading indicator.

See Also

svg()

Gets the UI component's SVG markup.

Return Value:

String

The UI component's SVG markup.

viewport()

Gets the current map viewport coordinates.

Return Value:

Array<Number>

The viewport coordinates.

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

View Demo

See Also

viewport(viewportCoordinates)

Sets the map viewport coordinates.

Parameters:
viewportCoordinates:

Array<Number>

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.

View Demo

See Also

zoomFactor()

Gets the current zoom factor value.

Return Value:

Number

The zoom factor value.

View Demo

See Also

zoomFactor(zoomFactor)

Sets the zoom factor value.

Parameters:
zoomFactor:

Number

A new zoom factor value. Pass null to reset the zoom factor.

To change the zoom factor, pass an numeric value as the argument to the zoomFactor(zoomFactor) method.

In addition, you can get the current value of the map zoom factor by calling the same method without arguments. Moreover, you can perform specific actions when the zoom factor is changed. For this purpose, implement a callback function and assign it to the onZoomFactorChanged property.

See Also