Type class
Baseclass for MapArea, MapLine and MapImage, it overwrites the default settings from AreasSettings, LinesSettings and ImagesSettings.
Example
var map = AmCharts.makeChart("mapdiv",{ ... "dataProvider": { "map": "worldHigh", "areas": [ { "id": "LT", "showAsSelected": true } ], "lines": [ { "latitudes": [51.5002, 50.4422], "longitudes": [-0.1262, 30.5367] } ], "images": [ { "type": "circle", "top": 100, "left": 100 } ] } });
Inheritance
MapObject does not extend any other symbol.
MapObject is extended by MapImage
, MapLine
, MapArea
, MapData
.
Properties
accessibleLabel # |
Type Text which screen readers will read if user rolls-over the object or sets focus using tab key (this is possible only if tabIndex property of object settings or individual object is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this. |
---|---|
alpha # |
Type Opacity of map object. |
balloonText # |
Type 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 Specifies if the object should change it's z-index to the top-most when user hovers it. |
color # |
Type Color of MapObject |
customData # |
Type A custom data holder. |
description # |
Type 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. |
descriptionWindowBottom # |
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 Height of description window. |
descriptionWindowLeft # |
Type 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 # |
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 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 Width of description window. |
fixedSize # |
Type Default 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 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. |
id # |
Type Unique id of the object. In case it's area, id should match svg path id from SVG file. Id can be used with linkToObject property of MapObject - you can link one object to another using it. |
images # |
Type Array of MapImage objects. |
lines # |
Type Array of MapLine objects. |
linkToObject # |
Type 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 Default Set this to false to make the object be irresponsive to any interactions like hover or click events. |
passZoomValuesToTarget # |
Type Default Specifies if current zoom values should be passed to target MapObject. Useful when building drill down maps. |
remainVisible # |
Type Default 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 Roll over color of of the object. |
selectable # |
Type Default 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 Color of an object when it is selected (somebody clicked on it). |
showAsSelected # |
Type Default 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, images, lines) have to look like they are selected. By setting this property to true, you will be able to produce this result. |
showInList # |
Type Specifies if this object must be displayed in ObjectsList Title should be defined in order the object to appear there. |
tabIndex # |
Type In case you set it to some number, the map will set focus on this object 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 object settings or individual object. If object is clickable, pressing Enter/Return while focus is set will select the object. Note, not all browsers and readers support this. |
title # |
Type 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 Url of an object. The application will go to this url when you click on the object. |
urlTarget # |
Type Default Target of an URL, if URL is a string, for example: "_blank", "_top". |
useTargetsZoomValues # |
Type Default If set to |
zoomLatitude # |
Type Specifies latitude to which map should be moved when this object is clicked |
zoomLevel # |
Type Specifies map scale to which map should be rescaled when this object is clicked. |
zoomLongitude # |
Type Specifies longitude to which map should be moved when this object is clicked. |
zoomX # |
Type 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 zoomX and zoomY. |
zoomY # |
Type 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 zoomX and zoomY. |
Methods
MapObject does not have any methods.
Events
MapObject does not have any events.
Adapters
MapObject does not have any adapters.