Methods

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

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

center()

Gets the current coordinates of the map center.

Return Value: Array
The current coordinates of the map center.

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

View Demo

center(centerCoordinates)

Sets the coordinates of the map center.

Parameters:
centerCoordinates: Array
New coordinates for the map center. 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.

View Demo

clearAreaSelection()

Deprecated

Use the layer's 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()

Deprecated

Use the layer's 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.

Show Example:
jQuery

In this example, you can select several areas and markers on the map by clicking. To clear the selection, click the Deselect the Map Elements button under the map. This button calls the clearSelection() method of the widget instance, which deselects all the map areas and markers.


                                    

                                    

convertCoordinates(x, y)

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
Map coordinates.

element()

Returns the root HTML element of the widget.

Return Value: jQuery
The root element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

getAreas()

Deprecated

Use the layer's getElements() method instead.

Returns an array with all the map areas.

Return Value: Array
An array of the map areas.

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

getLayerByIndex(index)

Gets the layer by its index.

Parameters:
index: Number
The index in the layers array.
Return Value: MapLayer
The requested layer.

getLayerByName(name)

Gets the layer by its name.

Parameters:
name: String
The name of the required layer.
Return Value: MapLayer
The requested layer.

getLayers()

Gets all map layers.

Return Value: Array
The array of layers.

Show Example:
jQuery

In this example, click the button under the map to select an area. The area to be selected is chosen randomly from a pool of all the map areas. The array of the map areas is obtained using the getAreas() method.


                                    

                                    

getMarkers()

Deprecated

Use the layer's getElements() method instead.

Returns an array with all the map markers.

Return Value: Array
An array of the map markers.

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

hideLoadingIndicator()

Conceals the loading indicator.

Although the loading indicator hides automatically when a map is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.

To show the loading indicator, invoke the showLoadingIndicator() method.

Show Example:
jQuery

In this example, the map options are assigned five seconds after the example is loaded. You can show/hide the loading indicator using the buttons under the map. Note that the loading indicator can be displayed or concealed manually at any time regardless of whether the map is ready or not.


                                    

                                    

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

Show Example:
jQuery

In the following example, the instance() method is used to get access to the map options. This method is called not like the other methods. To call the instance() method, the following construction is used.

JavaScript
$('#mapContainer').dxVectorMap('instance')

Use the drop-down menu below to choose which palette to use for coloring the map.


                                    

                                    

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
Return Value: Object
The object for which this method is called.

on(events)

Subscribes to the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

Show Example:
jQuery

In this example, the option() method is used to obtain the value of the tooltip | enabled option and display it under the map. To change this value, use the check box below.


                                    

                                    

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

Show Example:
jQuery

In this example, the option() method is used to obtain the value of the tooltip | enabled option and display it under the map. To change this value, use the check box below.


                                    

                                    

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

Show Example:
jQuery

In this example, the option(optionName, optionValue) method is used to set the value of the tooltip | enabled option at runtime. To change this value, use the check box below.


                                    

                                    

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

Show Example:
jQuery

In this example, the option(options) method is used to set the value of the tooltip | enabled and controlBar | eanbled options at runtime. To change these values, use the check box below.


                                    

                                    

render()

Redraws a widget.

By default, a widget rerenders when the size of the parent window is changed. But there may be situations when a widget should be rerendered manually, e.g., when the size of the widget container is changed. To make a widget rerender, call the render() method.

Show Example:
jQuery

Click the 'Change the container size' button to switch between two sizes of the map container. You can set the size either to 500x800 or 400x700 pixels. The render() method is used to redraw the map after the container size changes.


                                    

                                    

showLoadingIndicator()

Displays the loading indicator.

The loading indicator does not appear automatically. In order to display it, the showLoadingIndicator() method should be invoked.

To hide the loading indicator from code, use the hideLoadingIndicator() method.

Show Example:
jQuery

In this example, the map options are assigned five seconds after the example is loaded. You can show/hide the loading indicator using the buttons under the map. Note that the loading indicator can be displayed or concealed manually at any time regardless of whether the map is ready or not.


                                    

                                    

svg()

Returns the widget's SVG markup.

Return Value: String
The widget's SVG markup.

NOTE: This method does not support Internet Explorer 8.

Show Example:
jQuery

Click the Get SVG below the map and the SVG copy of this map will appear.


                                    

                                    

viewport()

Gets the current coordinates of the map viewport.

Return Value: Array
The current coordinates of the map viewport.

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

View Demo

viewport(viewportCoordinates)

Sets the coordinates of the map viewport.

Parameters:
viewportCoordinates: Array
New coordinates for the map viewport. 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 value of the map zoom factor.

Return Value: Number
The current value of the zoom factor.

zoomFactor(zoomFactor)

Sets the value of the map zoom factor.

Parameters:
zoomFactor: Number
A new value of the zoom factor. 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.