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

Gets the current map center coordinates.

Return Value:

Array<Number>

The current map center coordinates.

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

View Demo

See Also

center(centerCoordinates)

Sets the map center coordinates.

Parameters:
centerCoordinates:

Array<Number>

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.

View Demo

See Also

clearAreaSelection()

Deprecated

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.

See Also

clearMarkerSelection()

Deprecated

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.

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.

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's 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<Number>

Map coordinates.

See Also

dispose()

Removes the widget from the DOM.

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

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

See Also

endUpdate()

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

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget.

Parameters:
fileName:

String

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

format:

String

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.
See Also

getAreas()

Deprecated

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.

See Also

getInstance(element)

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

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getLayerByIndex(index)

Gets a layer with a specific index.

Parameters:
index:

Number

The index in the layers array.

Return Value:

Layer Element

The Layer object.

See Also

getLayerByName(name)

Gets a layer with a specific name.

Parameters:
name:

String

The layer's name.

Return Value:

Layer Element

The Layer object.

See Also

getLayers()

Gets all layers.

Return Value:

Array<Layer Element>

The Layer objects.

See Also
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 getLayers() method instead.

Gets all the map markers.

Return Value:

Array<Marker>

The Marker objects.

See Also

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.
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
Show Example:
jQuery

In this example, data is loaded with five seconds delay. You can show/hide the loading indicator using the buttons under the widget. Note that the loading indicator can be displayed or concealed manually at any time no matter whether the data is loaded or not.


                                    

                                    

instance()

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

Return Value:

Object

This widget's instance.

See Also
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 a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

Return Value:

Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

Return Value:

Object

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

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Object

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

option()

Gets all widget options.

Return Value:

Object

The widget's options.

See Also
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 a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

See Also
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)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

See Also
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)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also
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.


                                    

                                    

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.

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

Shows the loading indicator.

Show Example:
jQuery

In this example, the loading indicator is displayed until data is ready (5 seconds in this example). You can show and hide the loading indicator using the corresponding buttons below.


                                    

                                    

svg()

Gets the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

Show Example:
jQuery

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


                                    

                                    

viewport()

Gets the current map viewport coordinates.

Return Value:

Array<Number>

The viewport coordinates.

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

View Demo

See Also

viewport(viewportCoordinates)

Sets the map viewport coordinates.

Parameters:
viewportCoordinates:

Array<Number>

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.

View Demo

See Also

zoomFactor()

Gets the current zoom factor value.

Return Value:

Number

The zoom factor value.

View Demo

See Also

zoomFactor(zoomFactor)

Sets the zoom factor value.

Parameters:
zoomFactor:

Number

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