React VectorMap Methods
This section describes the methods that can be used in code to manipulate objects related to the UI component.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
center()
Gets the current map center coordinates.
This method returns the center coordinates as an array of two values in the [longitude, latitude] format.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 property.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
convertToGeo(x, y)
Converts coordinates from pixels to the dataSource coordinate system.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
convertToXY(longitude, latitude)
Converts coordinates from the dataSource coordinate system to pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
dispose()
Disposes of all the resources allocated to the VectorMap instance.
After calling this method, remove the DOM element associated with the UI component:
$("#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
<dx-vector-map ... *ngIf="condition"> </dx-vector-map>
Vue
<template> <DxVectorMap ... v-if="condition"> </DxVectorMap> </template> <script> import DxVectorMap from 'devextreme-vue/vector-map'; export default { components: { DxVectorMap } } </script>
React
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.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
exportTo(fileName, format)
Exports the UI component.
See Also
- DevExpress.viz.exportWidgets(widgetInstances, options)
- export
- print()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
Gets the instance of a UI component found using its DOM node.
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.
The Layer object.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getLayerByName(name)
Gets a layer with a specific name.
The Layer object.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getLayers()
Gets all layers.
The Layer objects.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getSize()
Gets the current UI component size.
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- showLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all UI component properties.
The UI component's properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single property.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several properties.
Propertieswith their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
print()
Opens the browser's print window.
See Also
- exportTo(fileName, format)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an property to its default value.
An property's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showLoadingIndicator()
Shows the loading indicator.
See Also
- hideLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
svg()
Gets the UI component's SVG markup.
The UI component's SVG markup.
See Also
- DevExpress.viz.getMarkup(widgetInstances)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
viewport()
Gets the current map viewport coordinates.
This method returns the viewport coordinates as an array of four values in the [minLongitude, maxLatitude, maxLongitude, minLatitude] form.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
zoomFactor()
Gets the current zoom factor value.
The zoom factor value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 property.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.