An object specifying options for the map areas.
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.
Use the borderColor option instead.
Specifies a color for the area border.
Use the borderWidth option instead.
Specifies the width of the area border in pixels.
Use the color option instead.
Specifies a color for an area.
Use the colorGroupingField option instead.
Specifies the field that provides data to be used for coloring areas.
If you need for the color of a specific map area to depend on the value of one of its attributes, assign the name of this attribute to the colorGroupingField option. The attribute must contain numeric values. After that, specify groups into which attribute values must be classified. For this purpose, assign an array to the colorGroups option. Each group in this array will be assigned a color from the palette.
Use the colorGroups option instead.
Allows you to paint areas with similar attributes in the same color.
If you have specified the field that provides area-coloring data, you need to specify groups into which this data must be classified. For this purpose, assign an array of numbers to the colorGroups option. Each pair of numbers in this array defines a range of data values.
For example, imagine that the colorGroups array contains four items: [0, 1, 2, 3]. This array specifies three ranges, or groups: 0-1, 1-2 and 2-3. Thus, data values will be split up into three groups. Each group will be assigned a color from the palette in order to paint the corresponding areas. Areas of those data values that do not match neither group will be drawn in a default color.
Use the customize option instead.
Specifies the function that customizes each area individually.
When implementing a function for this option, use the fields of the Area object. To access this object, use the function's parameter or the this object.
The customize function should return the object that contains options to be changed for a certain area. These options are listed below.
Specifies whether or not an area is selected when the map is created. To select an area at runtime, use the selected(state) method.
Specifies the index of the color when using palettes. This option is ignored when the color field is specified.
Use the hoveredBorderColor option instead.
Specifies a color for the area border when the area is hovered over.
Use the hoveredBorderWidth option instead.
Specifies the pixel-measured width of the area border when the area is hovered over.
Use the hoveredColor option instead.
Specifies a color for an area when this area is hovered over.
Use the hoverEnabled option instead.
Specifies whether or not to change the appearance of an area when it is hovered over.
Use the label option instead.
Configures area labels.
An area label is a text that accompanies a map area. Usually, an area label displays the name of a certain geographical object, such as a country, a continent, etc.
Texts for area labels are provided by one of the fields of the attributes object. This object must be declared in the map data source, while the required field must be assigned to the dataField option of the label object.
If you have provided data for area labels, enable them on your map by assigning true to the enabled option of the label object.
In addition, you can change the appearance of area labels using the label | font object.
Use the palette option instead.
Specifies the name of the palette or a custom range of colors to be used for coloring a map.
A palette defines a range of colors that are used to paint areas on a map. This range is divided into segments using the value assigned to the paletteSize option. Each segment contributes a color into a resulting array of colors. The more of these segments, the greater the variety of colors in this array. All available palettes are listed in the accepted values.
In order to apply a palette to a map, follow the next steps.
- Assign the name of the required palette (or an array of two colors) to the palette option.
- Use the paletteSize option to define how many colors should be produced from the palette or array specified in the previous step.
- Specify the index of the color from the colors array, which should be used for coloring an area, using the paletteIndex field of the object returned by the customize callback function.
Use the paletteSize option instead.
Specifies the number of colors in a palette.
Assign a number that is greater than 0 to this option in order to use palettes.
Use the selectedBorderColor option instead.
Specifies a color for the area border when the area is selected.
Use the selectedBorderWidth option instead.
Specifies the pixel-measured width of the area border when the area is selected.
Use the selectedColor option instead.
Specifies a color for an area when this area is selected.
Use the selectionMode option instead.
Specifies whether single or multiple areas can be selected on a vector map.
Several options and methods are connected with the selection operation. To specify whether single or multiple areas can be selected at a time, use the selectionMode option. To determine whether a certain area is selected when the widget is created, use the isSelected field of the object returned by the customize callback function.
At runtime, you can do the following operations.
Obtain the current selection state of an area using its selected() method.
Change the current selection state of an area using its selected(state) method. Pass true or false to this method.
Deselect all the selected areas using the clearAreaSelection() method of the map instance.
The change of the selection state invokes the callback function assigned to the onAreaSelectionChanged option. Within this function you can handle the selection event in the manner you require.