React VectorMap Methods
This section describes the methods that can be used in code to manipulate objects related to the widget.
beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
center(centerCoordinates)
Sets the map center 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.
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.
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
$("#myVectorMap").dxVectorMap("dispose"); $("#myVectorMap").remove();
Angular
<dx-vector-map #vectorMapVar id="myVectorMap"></dx-vector-map>
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.
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()
See Also
exportTo(fileName, format)
Exports the widget.
See Also
- DevExpress.viz.exportFromMarkup(markup, options)
- export
- print()
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
getInstance(element)
Gets the instance of a widget found using its DOM node.
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);
See Also
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.
See Also
- showLoadingIndicator()
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
print()
Opens the browser's print window.
See Also
- exportTo(fileName, format)
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
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.
See Also
showLoadingIndicator()
Shows the loading indicator.
See Also
- hideLoadingIndicator()
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
svg()
Gets the widget's SVG markup.
The widget's SVG markup.
See Also
- DevExpress.viz.getMarkup(widgetInstances)
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
viewport(viewportCoordinates)
Sets the map viewport coordinates.
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.
See Also
zoomFactor(zoomFactor)
Sets the zoom factor value.
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 option.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.