Methods

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

beginUpdate()

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

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

NOTE: It is recommended that you do not perform any actions on a widget within the updating transaction other than changing widget options.

clearAreaSelection()

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.

Show Example:
jQuery

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


                                    

                                    

clearMarkerSelection()

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.

Show Example:
jQuery

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


                                    

                                    

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.


                                    

                                    

endUpdate()

Enables the widget to refresh after the beginUpdate method call.

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

NOTE: It is recommended that you do not perform any actions on a widget within the updating transaction other than changing widget options.

getAreas()

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.

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

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.

Show Example:
jQuery

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


                                    

                                    

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 the widget.

Return Value: Object
An instance of the widget.

Use this method to access the widget.

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.

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

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


                                    

                                    

option()

Returns the object representing the configuration options of the widget.

Return Value: Object
The object representing the configuration options of the widget.

Use the fields of the returned object to configure the widget.

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 the widget.

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

To get the value of a configuration option, specify the path to the field representing this option in the configuration object. For example, pass the "tooltip.enabled" value as the optionName parameter to get the value of the tooltip | enabled option.

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 the widget.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value to be assigned to the required option.

To set a value to the configuration option, specify the path to the field representing this option in the configuration object. For example, to set the tooltip | enabled option to true, pass the "tooltip.enabled" value as the optionName parameter and the "true" value as the optionValue parameter.

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

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

To set one or more widget options, pass the object that contains fields representing these options as the options parameter.

This method is useful if you need to configure several widget options at once.

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.