AreasSettings

Type class

AreasSettings is a class which defines the default settings for all MapArea objects.

Example

```js var map = AmCharts.makeChart("mapdiv",{ ... "areasSettings": { "alpha": 0.5 } });```

Sources

This information about AreasSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

AreasSettings does not extend any other symbol.

AreasSettings is not extended by any other symbol.

Properties

#accessibleLabel

Type stringDefault [[title]] [[value]] [[description]]

Text which screen readers will read if user rolls-over the area or sets focus using tab key (this is possible only if tabIndex property of AreasSettings or individual area is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this.

#adjustOutlineThickness

Type booleanDefault true

By default the map will adjust area outlines when zooming in/out so that they will always stay of the same width. This however loads CPU quite a lot. If you set it to false, outlines will scale together with the areas.

#alpha

Type numberDefault 1

Opacity of areas.

#autoZoom

Type booleanDefault false

Specifies if the areas should be zoomed-in when user clicks on them, event if zoom properties are not set.

#balloonText

Type stringDefault [[title]]

Text which is displayed in a roll-over balloon. You can use the following tags: title, description, value and percent.

To disable the balloons, set it to an empty string.

#bringForwardOnHover

Type booleanDefault true

Specifies if the area should change it's z-index to the most top when user hovers it.

#color

Type colorDefault #FFCC00

Color of the areas.

#colorSolid

Type colorDefault #990000

Color of area with highest value. Colors for areas with values less then highest will be colored with intermediate colors between color and colorSolid. Use colorSteps property of AmMap to change the number of intermediate colors.

#descriptionWindowBottom

Type number

Distance from the bottom side of map container to the description window. In case it is not set (also if descriptionWindowTop is not set), window will be placed near the mouse pointer.

#descriptionWindowHeight

Type number

Height of a description window.

#descriptionWindowLeft

Type number

Distance from the left side of map container to the description window. In case it is not set (also if descriptionWindowRight is not set), window will be placed near the mouse pointer.

#descriptionWindowRight

Type number

Distance from the right side of map container to the description window. In case it is not set (also if descriptionWindowLeft is not set), window will be placed near the mouse pointer.

#descriptionWindowTop

Type number

Distance from the top side of map container to the description window. In case it is not set (also if descriptionWindowBottom is not set), window will be placed near the mouse pointer.

#descriptionWindowWidth

Type numberDefault 250

Width of a description window.

#outlineAlpha

Type numberDefault 1

Opacity of area's outline.

#outlineColor

Type colorDefault #FFFFFF

Color of area's outline.

#outlineThickness

Type numberDefault 1

Thickness of area's outline.

#rollOverColor

Type color

Color of area when user rolls-over it. You can set this to "undefined" (no quotes) to make the area retain it's original color when hovered.

#rollOverOutlineAlpha

Type number

Opacity of rolled-over area outline.

#rollOverOutlineColor

Type colorDefault #CC0000

Color of area's outline when user rolls-over it.

#rollOverOutlineThickness

Type numberDefault 1

Thickness of rolled-over area outline.

#selectable

Type booleanDefault false

Specifies if areas are selectable, even no zoom/description/url is set. You can also override this setting for each individual area individually.

#selectedColor

Type colorDefault #CC0000

Color of area which is currently selected. You can set this to "undefined" (no quotes) to make the area retain it's original color when selected.

#selectedOutlineColor

Type color

Color of selected area's outline.

#selectedOutlineThickness

Type number

Thickness of selected area outline.

#tabIndex

Type number

In case you set it to some number, the map will set focus on areas (one by one) when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read label which is set using accessibleLabel property of AreasSettings or individual area. If area is clickable, pressing Enter/Return while focus is set will select the area. Note, not all browsers and readers support this.

#unlistedAreasAlpha

Type numberDefault 1

Opacity of all areas which are in the map svg file, but not listed as areas in DataSet.

#unlistedAreasColor

Type colorDefault #DDDDDD

Color of all areas which are in the map svg file, but not listed as areas in DataSet.

#unlistedAreasOutlineAlpha

Type numberDefault 1

Opacity of all areas' outline which are in the map svg file, but not listed as areas in DataSet.

#unlistedAreasOutlineColor

Type colorDefault #FFFFFF

Color of all areas' outline which are in the map svg file, but not listed as areas in DataSet.

Methods

AreasSettings does not have any methods.

Events

AreasSettings does not have any events.