Type class
AmMap is the main class of the AmMap application. Example:
var map = new AmCharts.AmMap(); map.pathToImages = "http://www.ammap.com/lib/images/"; map.dataProvider = {mapVar: AmCharts.maps.worldLow}; map.write("mapdiv");
Inheritance
AmMap extends AmChart
.
AmMap is not extended by any other symbol.
Properties
allowClickOnSelectedObject # |
Type Default Specifies if user can repeatedly click on already selected object. |
---|---|
allowMultipleDescriptionWindows # |
Type Default Specifies if multiple description windows at a time are allowed. When set to false, previously opened window is closed when opening a new one. |
areasSettings # |
Type Default Common settings of areas. |
backgroundZoomsToTop # |
Type Default Specifies if clicking on the "water" zooms to the "top" |
balloonLabelFunction # |
Type Method which will be called by the map when a balloon with some text is displayed. You can use it to change the default text of a balloon.When this function is called, mapObject and map references are passed to it: balloonLabelFunction(mapObject, ammap); You can extract any data from mapObject and return new balloon text. |
centerMap # |
Type Default Specifies if the map should be centered. |
colorSteps # |
Type Default If you set values for MapAreas, they are filled with colors between color and colorSolid (both set in AreasSettings). colorSteps property specifies how many different colors should be used. Set this to some big number like 100 if you want each area to be filled with a different shade of color (according to it's value). |
dataProvider # |
Type Data provider of the map. |
developerMode # |
Type Default When developer mode is set to true, you can click anywhere on the map while SHIFT key is pressed to trigger a writeDevInfo event. All the information about current map position/zoom will be transferred to the event handler. |
dragMap # |
Type Default Specifies if the map is draggable. |
fitMapToContainer # |
Type Default Specifies if the map should be resized to fit to the stage. |
imagesSettings # |
Type Default Common settings of images. |
linesAboveImages # |
Type Default You can specify whether lines should be above or below images. |
linesSettings # |
Type Default Common settings of lines. |
mapVar # |
Type |
maxValue # |
Type Use this property in case you set values for your areas and wish to set a different maxValue. These values are used when choosing a color for an area. |
minValue # |
Type Use this property in case you set values for your areas and wish to set a different minValue (it's 0 by default). These values are used when choosing a color for an area. |
mouseWheelZoomEnabled # |
Type Default Specifies if zooming with mouse wheel is enabled. |
selectedObject # |
Type Default Read-only. Returns currently selected map object. Use map.selectObject(mapObject) method to change it. |
showAreasInList # |
Type Default Specifies if MapAreas should be displayed in the ObjectList. |
showBalloonOnSelectedObject # |
Type Default Specifies if balloon should be displayed when hovering currently seleced object. |
showDescriptionOnHover # |
Type Default Specifies if description window should be shown when user hovers over the object. |
showImagesInList # |
Type Default Specifies if MapImages should be displayed in the ObjectList. |
showLinesInList # |
Type Default Specifies if MapLines should be displayed in the ObjectList. |
showObjectsAfterZoom # |
Type Default Specifies if child objects should be added to stage only after the map zoomed to the final position. |
smallMap # |
Type Default Small map displays a small map indicating zoom level and position. |
useHandCursorOnClickableOjects # |
Type Default pecifies if hand cursor should be displayed when mouse moves over a clickable object. |
useObjectColorForBalloon # |
Type Default Specifies if balloon should use color of currenlty hovered object. |
valueLegend # |
Type Value legend displays a color range used by areas (in case you set values for your areas). |
zoomControl # |
Type Default Zoom control of the map. |
zoomDuration # |
Type Default Duration of zoom animation, in seconds. |
zoomOnDoubleClick # |
Type Default Specifies if the map should be zoomed-in when user double clicks anywhere on the map (except objects which are clickable). |
backgroundColor # |
Type Default Inherited from Background color. You should set backgroundAlpha to >0 value in order background to be visible. We recommend setting background color directly on a chart's DIV instead of using this property. |
balloon # |
Type Default Inherited from The chart creates AmBalloon class itself. If you want to customize balloon, get balloon instance using this property, and then change balloon's properties. |
borderAlpha # |
Type Default Inherited from Opacity of chart's border. Value range is 0 - 1. |
borderColor # |
Type Default Inherited from Color of chart's border. You should set borderAlpha >0 in order border to be visible. We recommend setting border color directly on a chart's DIV instead of using this property. |
color # |
Type Default Inherited from Text color. |
fontFamily # |
Type Default Inherited from Font family. |
fontSize # |
Type Default Inherited from Font size. |
height # |
Type Default Inherited from Height of a chart. "100%" means the chart's height will be equal to it's container's (DIV) height and will resize if height of the container changes. Set a number instead of percents if your chart's size needs to be fixed. |
legendDiv # |
Type Inherited from Reference to the div of the legend. |
numberFormatter # |
Type Default Inherited from Object with precision, decimalSeparator and thousandsSeparator set which will be used for number formatting. Precision set to -1 means that values won't be rounded. |
panEventsEnabled # |
Type Default Inherited from This setting affects touch-screen devices only. If a chart is on a page, and panEventsEnabled are set to true, the page won't move if the user touches the chart first. If a chart is big enough and occupies all the screen of your touch device, the user won’t be able to move the page at all. That's why the default value is "false". If you think that selecting/panning the chart or moving/pinching the map is a primary purpose of your users, you should set panEventsEnabled to true. |
pathToImages # |
Type Inherited from Specifies path to the folder where images like resize grips, lens and similar are. |
percentFormatter # |
Type Default Inherited from Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values. |
prefixesOfBigNumbers # |
Type Default Inherited from Prefixes which are used to make big numbers shorter: 2M instead of 2000000, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true. |
prefixesOfSmallNumbers # |
Type Default Inherited from Prefixes which are used to make small numbers shorter: 2μ instead of 0.000002, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true. |
usePrefixes # |
Type Default Inherited from If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties. |
version # |
Type Inherited from Read-only. Indicates current version of a script. |
There are 17 inherited items currently hidden from this list. |
Methods
addLabel( |
Returns Inherited from Adds a label on a chart. You can use it for labeling axes, adding chart title, etc. x and y coordinates can be set in number, percent, or a number with ! in front of it - coordinate will be calculated from right or bottom instead of left or top. x - horizontal coordinate y - vertical coordinate text - label's text align - alignment (left/right/center) size - text size color - text color rotation - angle of rotation alpha - label alpha bold - specifies if text is bold (true/false), url - url of a |
---|---|
addLegend( |
Returns Inherited from Adds a legend to the chart. By default, you don't need to create div for your legend, however if you want it to be positioned in some different way, you can create div anywhere you want and pass id or reference to your div as a second parameter. (NOTE: This method will not work on StockPanel.) legend - AmLegend, legendDivID - id or reference to legend div (optional) |
addListener( |
Returns Inherited from Adds event listener to the object. type - string like 'dataUpdated' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens |
addTitle( |
Returns Inherited from Adds title to the top of the chart. Pie, Radar positions are updated so that they won't overlap. Plot area of Serial/XY chart is also updated unless autoMargins property is set to false. You can add any number of titles - each of them will be placed in a new line. To remove titles, simply clear titles array: chart.titles = []; and call chart.validateNow() method. text - text of a title size - font size color - title color alpha - title opacity bold - boolean value indicating if title should be bold. |
checkIfSelected( |
Returns Checks if the object is currently selected. In case map object is linked with currently selected map object, this method will return true. |
clear() |
Returns Inherited from Clears the chart area, intervals, etc. |
clearLabels() |
Returns Inherited from Removes all labels added to the chart. |
clearMap() |
Returns Removes the map and all objects from container. |
clickMapObject( |
Returns Simulates click on a map object - sets a new selectedObject and fires event. |
closeAllDescriptions() |
Returns Closes all open description windows. |
coordinateToLatitude( |
Returns Converts provided map y coordinate to latitude. |
getAreaCenterLatitude( |
Returns Returns latitude of the area center. |
getAreaCenterLongitude( |
Returns Returns longitude of the area center. |
getDevInfo() |
Returns Returns object with information about the current mouse position: {type:"writeDevInfo", chart:AmMap, zoomLevel:zoomLevel, zoomX:zoomX, zoomY:zoomY, zoomLatitude:zoomLatitude, zoomLongitude:zoomLongitude, latitude:latitude, longitude:longitude, left:left, top:top, right:right, bottom:bottom, percentLeft:percentLeft, percentTop:percentTop, percentRight:percentRight, percentBottom:percentBottom, str:string} |
getObjectById( |
Returns Returns MapObject by a given id. id - id of an object |
hideGroup( |
Returns Hides objects with provided group id |
invalidateSize() |
Returns Inherited from Use this method to force the chart to resize to it's current container size. |
kilometersToPixels( |
Returns Converts kilometers to pixels. Note, if the map size changes, this will also change. |
latitudeToCoordinate( |
Returns Converts provided latitude to y coordinate of the map. |
longitudeToCoordinate( |
Returns Converts provided longitude to x coordinate of the map. |
milesToPixels( |
Returns Converts miles to pixels. Note, if the map size changes, this will also change. |
moveDown() |
Returns Moves map down by panStepSize (property of ZoomControl) |
moveLeft() |
Returns Moves map left by panStepSize (property of ZoomControl). |
moveRight() |
Returns Moves map right by panStepSize (property of ZoomControl). |
moveUp() |
Returns Moves map up by panStepSize (property of ZoomControl). |
removeLegend() |
Returns Inherited from Removes chart's legend. |
removeListener( |
Returns Inherited from Removes event listener from chart object. chart - chart object, type - event name, handler - method |
returnInitialColor( |
Returns Returns initial color for map object. mapObject |
rollOutMapObject( |
Returns Simulates a roll-out off a map object. Usefull when you want to highlight some area or movie from other control. |
rollOverMapObject( |
Returns Simulates a roll-over of a map object. Usefull when you want to highlight some area or movie from other control. |
selectObject( |
Returns Selects map object - MapArea, MapImage, MapLine or MapData. If you want to return map to initial view, use map.selectObject() - with no MapObject set - this will select current dataProvider. mapObject |
showGroup( |
Returns Shows objects with provided group id. |
validateData() |
Returns Inherited from This method should be called after data in your data provider changed or a new array was set to dataProvider. After calling this method the chart will parse data and redraw. |
validateNow() |
Returns Inherited from This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called. |
write( |
Returns Inherited from Adds chart to the specified DIV. container - id of a DIV or DIV object which will hold the chart |
zoomIn() |
Returns Zooms in. Current zoomLevel is multiplied by zoomFactor (property of ZoomControl). |
zoomLatitude() |
Returns Returns current latitude of the point which is at the center of the map container. |
zoomLevel() |
Returns Returns current zoom level. |
zoomLongitude() |
Returns Returns current longitude of the point which is at the center of the map container. |
zoomOut() |
Returns Zooms out. Current zoomLevel is divided by zoomFactor (property of ZoomControl). |
zoomTo( |
Returns Zooms the map to provided zoom level and coordinates. |
zoomToGroup( |
Returns Zooms-in the map to so that all objects of a group would fit into AmMap container.Works only with grouped MapAreas, doesn't work with MapImages. The group property is an id of the group. Or you can pass array of areas (not necessary grouped). |
zoomToLongLat( |
Returns Zooms in the map and places provided latitude and longitude in the center of a component container. |
zoomToMapXY( |
Returns Zooms the map to provided coordinates. |
zoomToSelectedObject( |
Returns Zooms to currently selected object. |
zoomX() |
Returns Returns current zoom x coordinate |
zoomY() |
Returns Returns current zoom y coordinate. |
There are 12 inherited items currently hidden from this list. |
Events
#click |
Param Fired everytime user clicks on a map, except if the map was dragged or zoomed-in with zoomControl. By using this event and getDevInfo method you can build your custom map editing user interface. |
---|---|
#clickMapObject |
Param Dispatched when user clicks on a map object. |
#homeButtonClicked |
Param Dispatched when home icon of the ZoomControl is clicked |
#rollOutMapObject |
Param Dispatched when user rolls-out of a map object. |
#rollOverMapObject |
Param Dispatched when user rolls-over a map object. |
#selectedObjectChanged |
Param Dispatched when selected object changes. |
#writeDevInfo |
Param Dispatched when map.developerMode is set to true and user holds shift and clicks left mouse button. Use this to get zoom level and coordinates of clicked place. |
#zoomCompleted |
Param Dispatched when zooming is completed. |
#dataUpdated |
Param Inherited from Dispatched when chart is build for the first time or after validateData() method was called. |
#init |
Param Inherited from Dispatched when chart is build for the first time. |
#rendered |
Param Inherited from Dispatched when the chart is build for the first time. |
There are 3 inherited items currently hidden from this list. |
Adapters
AmMap does not have any adapters.