React 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 option.

clearAreaSelection()

Use the clearSelection() method instead.

Deselects all the selected areas on a map. The areas are displayed in their initial style after.

To select/deselect a certain area, use the selected(state) method of an area.

clearMarkerSelection()

Use the clearSelection() method instead.

Deselects all the selected markers on a map. The markers are displayed in their initial style after.

To select/deselect a certain marker, use the selected(state) method of a marker.

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)

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.

dispose()

Disposes of all the resources allocated to the VectorMap instance.

The following code disposes of an VectorMap instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery

JavaScript

$("#myVectorMap").dxVectorMap("dispose");
$("#myVectorMap").remove();

Angular

HTML

<dx-vector-map #vectorMapVar id="myVectorMap"></dx-vector-map>

TypeScript

import { ..., ViewChild } from "@angular/core";
import { DxVectorMapComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("vectorMapVar") vectorMap: DxVectorMapComponent;

    removeVectorMap (e) {
        this.vectorMap.instance.dispose();
        document.getElementById("myVectorMap").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

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

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

exportTo(fileName, format)

Exports the widget.

Parameters:

fileName:

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

format:

The file's format.
Possible values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

NOTE

IE9 and Safari on Mac OS do not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the export | proxyUrl option description.

getAreas()

Use the getLayers() method instead.

Gets an array with all the map areas.

Return Value:

Array<Area>

Area objects.

Discover which methods and fields of a map area you can use within the Area class description.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget 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.

getMarkers()

Use the getLayers() method instead.

Gets all the map markers.

Return Value:

Array<Marker>

The Marker objects.

getSize()

Gets the current widget size.

Return Value: BaseWidgetOptions_size

The current widget size.

Returns an object with the following fields.

width
The width of the widget in pixels.
height
The height of the widget in pixels.

hideLoadingIndicator()

Hides the loading indicator.

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

instance()

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

Return Value:

This widget'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 widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

print()

Opens the browser's print window.

render()

Redraws the widget.

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

showLoadingIndicator()

Shows the loading indicator.

svg()

Gets the widget's SVG markup.

Return Value:

The widget'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 widget 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: