Methods

This section describes the methods that can be used in code to manipulate the Area object.

applySettings(settings)

Applies the area settings specified as a parameter and updates the area appearance.

Parameters:
settings: Object
A configuration object for the area.

The settings object should contain options to be changed for a certain area. These options are listed below.

Show Example:
jQuery

In this example, the map areas are not highlighted initially. Click the button below the map to highlight them one-by-one.


                                    

                                    

attribute(name)

Return the value of an attribute.

Parameters:
name: String
The name of an attribute.
Return Value: Object|Array|Number|String|Boolean
The value of the required attribute.

The map data source can contain an object of attributes assigned to the attributes field. To obtain the value of an attribute, call the attribute(name) method with the name of the required attribute passed as the parameter.

Show Example:
jQuery

In this example, the attribute(name) method is used to obtain the name of the area that is currently hovered over. This name is displayed by a tooltip.


                                    

                                    

selected()

Provides information about the selection state of an area.

Return Value: Boolean
Selection state of the area.

When an area is selected, this method returns true. Otherwise, the returned value is false. To select/deselect an area at runtime, use the selected(state) method.

Show Example:
jQuery

In this example, the selected() method is used to check whether the clicked area is already selected. If so, this area deselects using the selected(state) method. Otherwise, it selects using the same method.


                                    

                                    

selected(state)

Sets a new selection state for an area.

Parameters:
state: Boolean
Specifies whether to select or deselect the area.

To select an area, pass true as the parameter. Otherwise, pass false. To specify the selection state of a certain area when configuring dxVectorMap, use the isSelected field of the object returned by the customize function.

Show Example:
jQuery

In this example, the selected() method is used to check whether the clicked area is already selected. If so, this area deselects using the selected(state) method. Otherwise, it selects using the same method.