MapArea

Type class

MapArea is a class where properties of areas in the SVG map are defined. In case some property is not defined in this class, MapArea will use AreasSettings class property with the same name.

Sources

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

Inheritance

MapArea extends MapObject.

MapArea is not extended by any other symbol.

Properties

#autoZoom

Type booleanDefault false

Specifies if the area should be zoomed-in when user clicks on it, even if zoom properties are not set.

#id

Type string

Id of the area in SVG file.

#outlineAlpha

Type number

Opacity of area's outline.

#outlineColor

Type string

Color of area's outline.

#outlineThickness

Type number

Thickness of area's outline.

#rollOverOutlineColor

Type string

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

#value

Type number

Value of the area. Areas will be filled with color range from AreasSettings.color to AreasSettings.colorSolid, depending on the value.

32 inherited items

#alpha

Type numberInherited from MapObject

Opacity of map object.

#balloonText

Type stringInherited from MapObject

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

#color

Type stringInherited from MapObject

Color of MapObject

#customData

Type objectInherited from MapObject

A custom data holder.

#description

Type stringInherited from MapObject

Description of MapObject. Description is displayed in DescriptionWindow (when user clicks on an object). It can also be displayed in a roll-over balloon. DescriptionWindow can display HTML formatted code.

#descriptionWindowHeight

Type numberInherited from MapObject

Height of description window.

#descriptionWindowWidth

Type numberInherited from MapObject

Width of description window.

#descriptionWindowX

Type numberInherited from MapObject

X position of description window. In case it is not set, window will be placed near the mouse pointer.

#descriptionWindowY

Type numberInherited from MapObject

X position of description window. In case it is not set, window will be placed near the mouse pointer.

#fixedSize

Type booleanDefault trueInherited from MapObject

Specifies if the object should change the size together with the map or keep fixed size. This applies for objects with lat and long properties set, as they move together with the map.

#groupId

Type stringInherited from MapObject

Id of a group. You can group MapObjects to groups. Grouped objects will change color together with this object when you roll-over it or click it. You can show/hide them using showGroup(groupId) and hideGroup(groupId) methods of AmMap class. You can also use map.zoomToGroup(groupId) methot to zoom-in the map so that all grouped objects are visible.

#images

Type arrayInherited from MapObject

Array of MapImage objects.

#lines

Type arrayInherited from MapObject

Array of MapLine objects.

#linkToObject

Type MapObjectInherited from MapObject

linkToObject can be a reference or id of some other MapObject - MapArea, MapImage or MapLine. It can also be a reference to another DataSet (but not an id). Then user clicks on this object the application would zoom-in to this objects' zoom position (if it is set) and then act as if the linkToObject was clicked. This can also be used for selecting the object you want to be selected right after the map is initialized, as DataSet extends MapObject class, you can specify linkToObject for your DataSet. When you link to another DataSet, you can build drill-down maps.

#mouseEnabled

Type booleanDefault trueInherited from MapObject

Set this to false to make the object be irresponsive to any interactions like hover or click events.

#objectType

Type stringInherited from MapObject

Read-only, type of the Object. Possible values are: "DataSet", "MapImage", "MapLine" and "MapArea".

#passZoomValuesToTarget

Type booleanDefault falseInherited from MapObject

Specifies if current zoom values should be passed to target MapObject. Useful when building drill down maps.

#remainVisible

Type booleanDefault trueInherited from MapObject

Specifies if the MapObject and other objects of the same level should remain visible if it was clicked and it has children MapObjects.

#rollOverColor

Type stringInherited from MapObject

Roll over color of of the object.

#selectable

Type booleanDefault falseInherited from MapObject

Specifies if the object can be selected even if it is not clickable. Map object is clickable if zoom properties are set or it has description or has children objects. Sometimes even non of the listed conditions is met you might need it to be clickable. You should set this property to true in this case.

#selectedColor

Type stringInherited from MapObject

Color of an object when it is selected (somebody clicked on it).

#showAsSelected

Type booleanDefault falseInherited from MapObject

Specifies if selectedColor should be applied to the object. AmMap can have only one selected item at a time, however there might be situations when multiple objects (areas, movies, lines) have to look like they are selected. By setting this property to true, you will be able to produce this result.

#showInList

Type booleanInherited from MapObject

Specifies if this object must be displayed in ObjectsList Title should be defined in order the object to appear there.

#title

Type stringInherited from MapObject

Title of a MapObject. It can be displayed in the roll-over balloon and in the header of description window. All areas in SVG maps distributed with amMap has country names (titles) hard coded in the SVG file.

#url

Type stringInherited from MapObject

Url of an object. The application will go to this url when you click on the object.

#urlTarget

Type stringDefault _selfInherited from MapObject

Target of an URL, if URL is a string, for example: "_blank", "_top".

#useTargetsZoomValues

Type booleanDefault falseInherited from MapObject

Specifies if MapObject's, specified in the url zoom values should be used. Useful when building drill down maps.

#zoomLatitude

Type numberInherited from MapObject

Specifies latitude to which map should be moved when this object is clicked

#zoomLevel

Type numberInherited from MapObject

Specifies map scale to which map should be rescaled when this object is clicked.

#zoomLongitude

Type numberInherited from MapObject

Specifies longitude to which map should be moved when this object is clicked.

#zoomX

Type numberInherited from MapObject

Specifies x position (in percents of stage width) to which map should be moved when this object is clicked. You can also use zoomLat and zoomLong instead of zoomY and zoomY.

#zoomY

Type numberInherited from MapObject

Specifies y position (in percents of stage height) to which map should be moved when this object is clicked. You can also use zoomLat and zoomLong instead of zoomY and zoomY.

Methods

MapArea does not have any methods.

Events

MapArea does not have any events.