AmMap

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");```

Sources

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

Inheritance

AmMap extends AmChart.

AmMap is not extended by any other symbol.

Properties

#allowClickOnSelectedObject

Type booleanDefault true

Specifies if user can repeatedly click on already selected object.

#allowMultipleDescriptionWindows

Type booleanDefault false

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 AreasSettingsDefault AreasSettings

Common settings of areas.

#backgroundZoomsToTop

Type booleanDefault false

Specifies if clicking on the "water" zooms to the "top"

#balloonLabelFunction

Type Function

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 booleanDefault true

Specifies if the map should be centered.

#colorSteps

Type numberDefault 5

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 MapData

Data provider of the map.

#developerMode

Type booleanDefault false

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 booleanDefault true

Specifies if the map is draggable.

#fitMapToContainer

Type booleanDefault true

Specifies if the map should be resized to fit to the stage.

#imagesSettings

Type ImagesSettingsDefault ImagesSettings

Common settings of images.

#linesAboveImages

Type booleanDefault true

You can specify whether lines should be above or below images.

#linesSettings

Type LinesSettingsDefault LinesSettings

Common settings of lines.

#mapVar

Type Variable

#maxValue

Type number

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 number

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 booleanDefault false

Specifies if zooming with mouse wheel is enabled.

#selectedObject

Type MapObjectDefault MapObject

Read-only. Returns currently selected map object. Use map.selectObject(mapObject) method to change it.

#showAreasInList

Type booleanDefault true

Specifies if MapAreas should be displayed in the ObjectList.

#showBalloonOnSelectedObject

Type booleanDefault true

Specifies if balloon should be displayed when hovering currently seleced object.

#showDescriptionOnHover

Type booleanDefault false

Specifies if description window should be shown when user hovers over the object.

#showImagesInList

Type booleanDefault false

Specifies if MapImages should be displayed in the ObjectList.

#showLinesInList

Type booleanDefault false

Specifies if MapLines should be displayed in the ObjectList.

#showObjectsAfterZoom

Type booleanDefault false

Specifies if child objects should be added to stage only after the map zoomed to the final position.

#smallMap

Type SmallMapDefault SmallMap

Small map displays a small map indicating zoom level and position.

#useHandCursorOnClickableOjects

Type booleanDefault true

pecifies if hand cursor should be displayed when mouse moves over a clickable object.

#useObjectColorForBalloon

Type booleanDefault true

Specifies if balloon should use color of currenlty hovered object.

#valueLegend

Type ValueLegend

Value legend displays a color range used by areas (in case you set values for your areas).

#zoomControl

Type ZoomControlDefault ZoomControl

Zoom control of the map.

#zoomDuration

Type numberDefault 1

Duration of zoom animation, in seconds.

#zoomOnDoubleClick

Type booleanDefault true

Specifies if the map should be zoomed-in when user double clicks anywhere on the map (except objects which are clickable).

17 inherited items

#backgroundColor

Type stringDefault #FFFFFFInherited from AmChart

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 AmBalloonDefault AmBalloonInherited from AmChart

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 numberDefault 0Inherited from AmChart

Opacity of chart's border. Value range is 0 - 1.

#borderColor

Type stringDefault #000000Inherited from AmChart

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 stringDefault #000000Inherited from AmChart

Text color.

#fontFamily

Type stringDefault VerdanaInherited from AmChart

Font family.

#fontSize

Type numberDefault 11Inherited from AmChart

Font size.

#height

Type Number/StringDefault 100%Inherited from AmChart

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 DIV objectInherited from AmChart

Reference to the div of the legend.

#numberFormatter

Type objectDefault {precision:-1, decimalSeparator:'.', thousandsSeparator:','}Inherited from AmChart

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 booleanDefault falseInherited from AmChart

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 stringInherited from AmChart

Specifies path to the folder where images like resize grips, lens and similar are.

#percentFormatter

Type objectDefault {precision:2, decimalSeparator:'.', thousandsSeparator:','}Inherited from AmChart

Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values.

#prefixesOfBigNumbers

Type arrayDefault [{number:1e+3,prefix:"k"},{number:1e+6,prefix:"M"},{number:1e+9,prefix:"G"},{number:1e+12,prefix:"T"},{number:1e+15,prefix:"P"},{number:1e+18,prefix:"E"},{number:1e+21,prefix:"Z"},{number:1e+24,prefix:"Y"}]Inherited from AmChart

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 arrayDefault [{number:1e-24, prefix:"y"},{number:1e-21, prefix:"z"},{number:1e-18, prefix:"a"},{number:1e-15, prefix:"f"},{number:1e-12, prefix:"p"},{number:1e-9, prefix:"n"},{number:1e-6, prefix:"μ"},{number:1e-3, prefix:"m"}]Inherited from AmChart

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 booleanDefault falseInherited from AmChart

If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties.

#version

Type stringInherited from AmChart

Read-only. Indicates current version of a script.

Methods

#checkIfSelected()

Returns Boolean

Checks if the object is currently selected. In case map object is linked with currently selected map object, this method will return true.

#clearMap()

Returns void

Removes the map and all objects from container.

#clickMapObject()

Returns void

Simulates click on a map object - sets a new selectedObject and fires event.

#closeAllDescriptions()

Returns void

Closes all open description windows.

#coordinateToLatitude()

Returns latitude

Converts provided map y coordinate to latitude.

#getAreaCenterLatitude()

Returns latitude

Returns latitude of the area center.

#getAreaCenterLongitude()

Returns longitude

Returns longitude of the area center.

#getDevInfo()

Returns Object

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 MapObject

Returns MapObject by a given id.

id - id of an object

#hideGroup()

Returns void

Hides objects with provided group id

#kilometersToPixels()

Returns pixels

Converts kilometers to pixels. Note, if the map size changes, this will also change.

#latitudeToCoordinate()

Returns y coordinate

Converts provided latitude to y coordinate of the map.

#longitudeToCoordinate()

Returns x coordinate

Converts provided longitude to x coordinate of the map.

#milesToPixels()

Returns pixels

Converts miles to pixels. Note, if the map size changes, this will also change.

#moveDown()

Returns void

Moves map down by panStepSize (property of ZoomControl)

#moveLeft()

Returns void

Moves map left by panStepSize (property of ZoomControl).

#moveRight()

Returns void

Moves map right by panStepSize (property of ZoomControl).

#moveUp()

Returns void

Moves map up by panStepSize (property of ZoomControl).

#returnInitialColor()

Returns void

Returns initial color for map object.

mapObject

#rollOutMapObject()

Returns void

Simulates a roll-out off a map object. Usefull when you want to highlight some area or movie from other control.

#rollOverMapObject()

Returns void

Simulates a roll-over of a map object. Usefull when you want to highlight some area or movie from other control.

#selectObject()

Returns void

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 void

Shows objects with provided group id.

#zoomIn()

Returns void

Zooms in. Current zoomLevel is multiplied by zoomFactor (property of ZoomControl).

#zoomLatitude()

Returns latitude

Returns current latitude of the point which is at the center of the map container.

#zoomLevel()

Returns zoom level

Returns current zoom level.

#zoomLongitude()

Returns longitude

Returns current longitude of the point which is at the center of the map container.

#zoomOut()

Returns void

Zooms out. Current zoomLevel is divided by zoomFactor (property of ZoomControl).

#zoomTo()

Returns void

Zooms the map to provided zoom level and coordinates.

#zoomToGroup()

Returns void

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 void

Zooms in the map and places provided latitude and longitude in the center of a component container.

#zoomToMapXY()

Returns void

Zooms the map to provided coordinates.

#zoomToSelectedObject()

Returns void

Zooms to currently selected object.

#zoomX()

Returns zoom x

Returns current zoom x coordinate

#zoomY()

Returns zoom y

Returns current zoom y coordinate.

12 inherited items

#addLabel()

Returns voidInherited from AmChart

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 voidInherited from AmChart

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 voidInherited from AmChart

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 voidInherited from AmChart

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.

#clear()

Returns voidInherited from AmChart

Clears the chart area, intervals, etc.

#clearLabels()

Returns voidInherited from AmChart

Removes all labels added to the chart.

#invalidateSize()

Returns voidInherited from AmChart

Use this method to force the chart to resize to it's current container size.

#removeLegend()

Returns voidInherited from AmChart

Removes chart's legend.

#removeListener()

Returns voidInherited from AmChart

Removes event listener from chart object.

chart - chart object, type - event name, handler - method

#validateData()

Returns voidInherited from AmChart

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 voidInherited from AmChart

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 voidInherited from AmChart

Adds chart to the specified DIV.

container - id of a DIV or DIV object which will hold the chart

Events

#click

Param { type: "click", target: AmMap } & {type:'click', chart:AmMap}

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 { type: "clickMapObject", target: AmMap } & {type:"clickMapObject", mapObject:MapObject, chart:AmMap}

Dispatched when user clicks on a map object.

#homeButtonClicked

Param { type: "homeButtonClicked", target: AmMap } & {type:"homeButtonClicked", chart:AmMap}

Dispatched when home icon of the ZoomControl is clicked

#rollOutMapObject

Param { type: "rollOutMapObject", target: AmMap } & {type:"rollOverMapObject", mapObject:MapObject, chart:AmMap}

Dispatched when user rolls-out of a map object.

#rollOverMapObject

Param { type: "rollOverMapObject", target: AmMap } & {type:"rollOverMapObject", mapObject:MapObject, chart:AmMap}

Dispatched when user rolls-over a map object.

#selectedObjectChanged

Param { type: "selectedObjectChanged", target: AmMap } & {type:'selectedObjectChanged', chart:AmMap}

Dispatched when selected object changes.

#writeDevInfo

Param { type: "writeDevInfo", target: AmMap } & {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}

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 { type: "zoomCompleted", target: AmMap } & {type:'zoomCompleted', chart:AmMap}

Dispatched when zooming is completed.

#dataUpdated

Param { type: "dataUpdated", target: AmMap } & {type:"dataUpdated", chart:AmChart}

Dispatched when chart is build for the first time or after validateData() method was called.

#init

Param { type: "init", target: AmMap } & {type:"init", chart:AmChart}

Dispatched when chart is build for the first time.

#rendered

Param { type: "rendered", target: AmMap } & {type:"rendered", chart:AmChart}

Dispatched when the chart is build for the first time.