Configuration

An object that specifies configuration options for the dxVectorMap widget.

areaSettings

An object specifying options for the map areas.

Type:

Object

The map areas usually represent geographical objects, such as countries, continents, etc. The appearance of these areas is specified by the options of the areaSettings configuration object. If these options are defined on the first level of the areaSettings object, they are applied to all the map areas at once. However, you can specify several of these options for certain areas exclusively. See the customize option description to learn how.

Show Example:
jQuery

In this example, areas are painted using the 'Vintage' palette. To specify different colors from this palette for the areas, the customize function returns an object that contains the specified palleteIndex field.


                                    

                                    

background

Specifies the options for the map background.

Type:

Object

The map background is a space on a map that does not contain areas. Within the background configuration object you can specify colors for the map background and its border.

Show Example:
jQuery

In this example, the background is colored in 'paleturquoise' using the color option. In addition, the background border is colored in 'dodgerblue' using the borderColor option.


                                    

                                    

bounds

Specifies the positioning of a map in geographical coordinates.

Type:

Array

| object deprecated
Default Value: undefined
Cannot be used in themes.

When you need to display only a specific region on a map, rather than the whole thing, specify the geographical coordinates of this region using the bounds option. Assign an array of four values to this option. These values represent geographical coordinates in the following format: [minLongitude, maxLatitude, maxLongitude, minLatitude]. See the image below to discover how these values are applied to the map.

ChartMargin ChartJS

NOTE
Specifying the bounds option with the { minLon: minLongitude, maxLat: maxLatitude, maxLon: maxLongitude, minLat: minLatitude } object is now deprecated.
Show Example:
jQuery

In this example, the map is focused on the USA in code using the bounds array.


                                    

                                    

center

Specifies the geographical coordinates of the center for a map.

Type:

Array

| object deprecated
Default Value: [0, 0]
Cannot be used in themes.

By default, the map in the dxVectorMap widget is centered on the (0, 0) point. If you need to center the map on a different geographical point, assign an array of two values in the [longitude, latitude] form.

NOTE
Specifying the center with the { lon: longitude, lat: latitude } object is now deprecated.
Show Example:
jQuery

In this example, the map is centered on Africa in code using the center option.


                                    

                                    

centerChanged

Deprecated

Use the onCenterChanged option instead.

click

Deprecated

Use the onClick option instead.

controlBar

Specifies the options of the control bar.

Type:

Object

The control bar is a panel on a map that helps you navigate this map. This panel contains the pan control and the zoom bar for panning and zooming the map correspondingly. You can change the visibility of the control bar and adjust its colors using the options of the controlBar configuration object.

Show Example:
jQuery

In this example, the appearance of the control bar is changed using the controlBar configuration object.


                                    

                                    

drawn

Deprecated

Use the onDrawn option instead.

incidentOccured

Deprecated

Use the onIncidentOccurred option instead.

legends[]

Configures map legends.

Type:

Array

Default Value: undefined

A legend is a supplementary map element that helps end-users identify a map area or a map marker. The dxVectorMap widget can display several legends simultaneously. To configure legends, declare an array of objects and assign it to the legends option. Each object in this array specifies settings of one legend. These settings are described in this section.

Each legend requires the source option to be set. This option specifies whether it is areas or markers that must be accompanied with a legend. Learn more from the description of the source option.

A map legend contains several legend items. A legend item consists of a marker and a text. You can change the size of markers using the markerSize option. To provide texts for legend items, you need to implement the customizeText function.

View Demo

loadingIndicator

Specifies the appearance of the loading indicator.

Type:

Object

Usually, the widget is quick enough to draw itself instantly for a viewer. There are, however, cases, when the widget takes longer to be drawn. In such cases, displaying the loading indicator is recommended. To display the loading indicator, assign true to the show field of the loadingIndicator object. Use other fields of this object to change the appearance of the loading indicator.

Show Example:
jQuery

In this example, data is assigned to the map 3000 ms after the example is loaded. Until that time, the loading indicator is displayed. Its background and font are changed using the backgroundColor and font options respectively.


                                    

                                    

mapData

Specifies a data source for the map area.

Type:

Array

|

String

Default Value: undefined
Cannot be used in themes.

This option specifies the set of areas presented on a map. To discover different approaches to providing data for map areas, see the Data for Areas article.

Show Example:
jQuery

Use the drop-down menu below to choose which data source to use for the map. In this example, each data source is represented by a JSON object.


                                    

                                    

markers

Specifies a data source for the map markers.

Type:

Array

|

String

Default Value: undefined
Cannot be used in themes.

Data you need to provide for map markers depends on the type of the markers you use. Generally, you need to declare an array of objects, each of which must hold the coordinates field specifying geographical coordinates of a marker. Additionally, you need to specify the value field (for bubble markers), or the values field (for pie markers), or the url field (for image markers). To display a label for a marker, specify the text field.

For a more comprehensive description of how to provide data for map markers, see the Data for Markers topic.

Show Example:
jQuery

In this example, several markers are displayed on the map. These markers indicate the capitals of ten most populous states in the USA.


                                    

                                    

markerSettings

An object specifying options for the map markers.

Type:

Object

A marker is a point on a map accompanied by text that helps you flag places on the map. For example, you can use markers to designate cities on the map. The appearance of the markers is specified by the options of the markerSettings configuration object. If these options are defined on the first level of the markerSettings object, they are applied to all the markers at once. However, you can specify several of these options for certain markers exclusively. See the customize option description to learn how.

Show Example:
jQuery

In this example, each marker is accompanied by a label that displays the name of the state's capital. This name is obtained from the 'name' attribute of the map's data source using the customize option. The font size of the labels is decreased so that the labels do not overlap each other. In addition, the capability to select/deselect a marker by a click is added using the callback function assigned to the click option. When a marker is selected, it is drawn in a color specified by the selectedColor option.


                                    

                                    

maxZoomFactor

Specifies a map's maximum zoom factor.

Type:

Number

Default Value: 256
Cannot be used in themes.

An end-user will not be able to zoom into a map larger than the factor specified here.

Show Example:
jQuery

In this example, the map's maximum zoom factor is set to 3.


                                    

                                    

onAreaClick

A handler for the areaClick event.

Type:

function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

jQueryEvent:

jQuery.Event

The jQuery event.

target:

Area

The clicked area.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked area. An object that represents this area has fields and methods documented in the Area class description.

Alternatively, you can navigate to a specific URL when the areaClick event fires. For this purpose, assign this URL to the onAreaClick option.

View Demo

Show Example:
jQuery

In this example, you can select an area by a click.


                                    

                                    

onAreaSelectionChanged

A handler for the areaSelectionChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

target:

Area

The selected/deselected area.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the selected/deselected area. An object that represents this area has fields and methods documented in the Area class description.

To identify whether an area has been selected or deselected, call its selected() method. Pass true or false to this method to select or deselect the area.

Show Example:
jQuery

In this example, you can select/deselect areas by a click. When the selection state of an area changes, the corresponding message appears below the map.


                                    

                                    

onCenterChanged

A handler for the centerChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

center:

Array

The updated geographical coordinates of the center.

Cannot be used in themes.

If you need to perform specific actions when the coordinates of the map center are changed, handle the centerChanged event. One of the ways to do this is to assign a function to the onCenterChanged option. This function will be called every time a user moves the map or when the center is being changed in code by calling the center(centerCoordinates) or viewport(viewportCoordinates) method. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the updated center coordinates.

View Demo

onClick

A handler for the click event.

Type:

function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

jQueryEvent:

jQuery.Event

The jQuery event extended by the x and y fields.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the object that represents the jQuery event extended by the following fields.

  • x
    Contains the X coordinate of the clicked point.
  • y
    Contains the Y coordinate of the clicked point.
NOTE
The coordinates are calculated relatively to the client area, i.e., the widget's container. To convert them into map coordinates, use the convertCoordinates(x,y) method.

Alternatively, you can navigate to a specific URL when the click event fires. For this purpose, assign this URL to the onClick option.

In addition, you can handle the areaClick and markerClick events. For this purpose, assign handling functions to the onAreaClick and onMarkerClick options. Note that in that case, the click event will fire anyway, but only after the areaClick or markerClick events.

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

onDrawn

A handler for the drawn event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Object

The widget's container.

Cannot be used in themes.

If you need to perform specific actions when the widget has finished drawing itself, assign a callback function to the drawn option. When implementing this function, you can access the drawn widget using the function's parameter.

onIncidentOccurred

A handler for the incidentOccurred event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Object

The widget's container.

target:

Object

Information about the occurred incident.

When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.

  • id
    Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
  • type
    Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
  • args
    Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
  • text
    Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
  • widget
    Contains the name of the widget that produced the error or warning.
  • version
    Contains the currently used version of the ChartJS library.

onInitialized

A handler for the initialized event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onMarkerClick

A handler for the markerClick event.

Type:

function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

jQueryEvent:

jQuery.Event

The jQuery event.

target:

Marker

The clicked marker.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked marker. An object that represents this marker has fields and methods documented in the Marker class description.

Alternatively, you can navigate to a specific URL when the markerClick event fires. For this purpose, assign this URL to the onMarkerClick option.

View Demo

Show Example:
jQuery

In this example, you can select/deselect a marker by a click. The function that performs the selection is assigned to the onMarkerClick option.


                                    

                                    

onMarkerSelectionChanged

A handler for the markerSelectionChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

target:

Marker

The selected/deselected area.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the selected/deselected marker. An object that represents this marker has fields and methods documented in the Marker class description.

To identify whether a marker has been selected or deselected, call its selected() method. Pass true or false to this method to select or deselect the marker.

Show Example:
jQuery

In this example, you can select/deselect markers by a click. When the selection state of a marker changes, the corresponding message appears under the map.


                                    

                                    

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onTooltipHidden

A handler for the tooltipHidden event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Object

The widget's container.

target:

Object

The area or marker for which a tooltip was displayed.

Cannot be used in themes.

The tooltip becomes invisible when a user hovers the mouse cursor over another marker/area or moves it outside the widget.

When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. To do this, implement a handling function and assign it to this option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the area or marker whose tooltip becomes hidden.

onTooltipShown

A handler for the tooltipShown event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Object

The widget's container.

target:

Object

The area or marker for which a tooltip is displayed.

Cannot be used in themes.

The tooltip appears when a user hovers the mouse cursor over a marker or area.

When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to this option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the area or marker whose tooltip appears.

onZoomFactorChanged

A handler for the zoomFactorChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Object

The widget's container.

zoomFactor:

Number

The updated zoom factor.

Cannot be used in themes.

If you need to perform specific actions when the map zoom factor is changed, handle the zoomFactorChanged event. One of the ways to do this is to assign a function to the onZoomFactorChanged option. This function will be called every time a user zooms the map or when the zoom factor is changed from code by calling the zoomFactor(zoomFactor) or viewport(viewportCoordinates) method. When implementing this function, use the object passed to it as the parameter. Among the fields of this object, you can find the updated zoom factor.

View Demo

panningEnabled

Disables the panning capability.

Type:

Boolean

Default Value: true

Setting this option to false disables a user to pan the map. However, you still can pan the map in code using the center(centerCoordinates) and viewport(viewportCoordinates) methods.

pathModified

Notifies a widget that it is embedded into an HTML page that uses a path modifier.

Type:

Boolean

Default Value: false
Cannot be used in themes.

If you place a widget on a page that uses a path modifier, notify the widget about it by setting the pathModified option to true. As an example of such modifiers, the base HTML tag can be considered. Also, we recommend you enable this option if you place the widget inside the <iframe> tag.

rtlEnabled

Specifies whether or not the widget supports right-to-left representation.

Type:

Boolean

Default Value: false
Cannot be used in themes.

The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.

size

Specifies the size of the dxVectorMap widget.

Type:

Object

By default, the widget occupies the entire area of the parent container (division). If the container width or height is set to zero, the widget is not displayed.

If you need to set a size for the widget that differs from the container's size, use the size configuration object. Assign a height and width in pixels to the height and width options of the size object.

Show Example:
jQuery

In this example, the size of the dxVectorMap widget is less than the container's size.


                                    

                                    

theme

Sets the name of the theme to be used in the widget.

Type:

String

Default Value: 'generic.light'
Accepted Values: 'generic.light'|'generic.dark'|'generic.contrast'|'android5.light'|'ios7.default'|'win8.black'|'win8.white'

Use this property to set a predefined or custom theme. The options defining chart appearance will be set to the values that are set in the specified theme. You can override some of these values within the chart's configuration object.

NOTE
The previous versions of theme names ('desktop'|'desktop-dark'|'android'|'android-holo-light'|'ios'|'win8'|'win8-white') are deprecated. Moreover, the 'ios' theme is replaced with its modern version — 'ios7.default', and the 'android' theme — with the modern 'android5.light' one. Please use theme names from the accepted values list for new applications.
Show Example:
jQuery

This example shows how to implement a custom theme on the base of a predefined one.


                                    

                                    

tooltip

Specifies tooltip options.

Type:

Object

A tooltip is a small pop-up rectangle that displays information about an area or a marker when it is hovered over. To show tooltips, do the following.

  • Enable tooltips. Set the enabled option to true.

  • Specify text to be displayed in tooltips. Specify the customizeToolitp option.

You can also change tooltip default appearance using the options of the tooltip configuration object.

View Demo

Show Example:
jQuery

In this example, tooltips display the name of the area that is currently hovered over. The tooltips' borders are colored in 'royalblue' using the border | color option. In addition, the tooltips' font color is set to 'dodgerblue' using the font | color option.


                                    

                                    

touchEnabled

Specifies whether the map should respond to touch gestures.

Type:

Boolean

Default Value: true

Assign false to this option if your map is not supposed to be viewed on touch-enabled devices.

wheelEnabled

Specifies whether or not the map should respond when a user rolls the mouse wheel.

Type:

Boolean

Default Value: true

Rolling the mouse wheel zooms a map. If you need to disable this capability, assign false to the wheelEnabled option. A user will still be able to zoom the map using the control bar.

zoomFactor

Specifies a number that is used to zoom a map initially.

Type:

Number

Default Value: 1
Cannot be used in themes.

Use this option to specify a zoom factor for a map while configuring it. This option accepts a value that is greater than 1. Note that the zooming is performed with relation to the center of the map.

Show Example:
jQuery

In this example, the map is initially zoomed twice as the zoomFactor option is set to 2.


                                    

                                    

zoomFactorChanged

Deprecated

Use the onZoomFactorChanged option instead.

zoomingEnabled

Disables the zooming capability.

Type:

Boolean

Default Value: true

Setting this option to false disables a user's ability to zoom the map. However, you can still zoom the map in code using the zoomFactor(zoomFactor) method.