AtlasCT.com
User Manual v5.0

OverviewMap

Inheritance: EventListener > OverviewMap

Summary
Inheritance: EventListener > OverviewMap
The OverviewMap constructor.
Returns the overview map background color.
Returns the overview map size.
Returns the map view.
Returns the zoom level of the overview map.
Sets the background color of the overview map.
Sets a new size to the overview map.
Sets the map view.
Writes the overview component code into the HTML document.

Constructors

OverviewMap

OverviewMap(string width
string height
Map parentMap
int zoomDelta)

The OverviewMap constructor.  Creates a new overview map instance.

Parameters

widthOverview map width.  Can also contain a percentage value.
heightOverview map height.  Can also contain a percentage value.
parentMapThe parent map to be synchronize with the overview map.
zoomDeltathe zoom level delta between the map and the overivew map. the value must be -1 and below.

Methods

getBgColor

string getBgColor()

Returns the overview map background color.

Returns

Overview map background color

getSize

MapSize getSize()

Returns the overview map size.

Returns

Overview map size

getView

Map Views getView()

Returns the map view.

Returns

Map view.

See Also

setView

getZoomLevel

int getZoomLevel()

Returns the zoom level of the overview map.

Returns

Zoom level of the overview map

setBgColor

setBgColor(string bgColor)

Sets the background color of the overview map.

Parameters

bgColorBackground color of the overview map.

setSize

setSize(MapSize mapSize)

Sets a new size to the overview map.

Parameters

mapSizeA new size to the overview map.

setView

setView(Map Views view)

Sets the map view.

Parameters

viewThe map view.

See Also

getView

writeMap

writeMap()

Writes the overview component code into the HTML document.

The EventListener class helps you to register event handlers defined by this API.
Some of the classes that inherit from this class are: Map, OverviewMap, LayersManager
OverviewMap(string width
string height
Map parentMap
int zoomDelta)
The OverviewMap constructor.
writeMap()
Writes the overview component code into the HTML document.
setBgColor(string bgColor)
Sets the background color of the overview map.
string getBgColor()
Returns the overview map background color.
setSize(MapSize mapSize)
Sets a new size to the overview map.
MapSize getSize()
Returns the overview map size.
setView(Map Views view)
Sets the map view.
Map Views getView()
Returns the map view.
int getZoomLevel()
Returns the zoom level of the overview map.
Inheritance: EventListener > Map
This class defines a map size.