AtlasCT.com
User Manual v5.0

TileOverlay

The TileOverlay class is used to add an image overlay on the map.  In order to add the image overlay on the map, you should create an TileOverlay object and attached it to the map by the addTileOverlayToMap method. After setting your TileOverlay on the map, it will maintain its geographical position and stretch according to any change in the zoom level of the map.


Summary
The TileOverlay class is used to add an image overlay on the map.
The TileOverlay constructor.
Returns the dom element of the image overlay.
Sets the dom element of the image overlay to be presented.
Sets a new name to the image overlay.
Gets the name of the image overlay.
Gets the image url of the image overlay.
Gets the bounds of the image overlay.

Constructors

TileOverlay

TileOverlay(string name
string image
Bounds bounds)

The TileOverlay constructor.  Creates a new TileOverlay instance.

Parameters

nameThe name of the tile overlay
imageThe image tile URL
boundsThe bounds for the tile overlay

Methods

getDomElement

DomElement getDomElement()

Returns the dom element of the tile overlay.

Returns

The tile overlay dom element.

setDomElement

setDomElement(DomElement domElement)

Sets the dom element of the tile overlay to be presented.

Parameters

domElementA dom element to be presented.

setName

setName(string name)

Sets a new name to the tile overlay.

Parameters

nameA new name to the tile overlay.

getName

getName()

Gets the name of the tile overlay.

getImgUrl

getImgUrl()

Gets the image url of the tile overlay.

getBounds

getBounds()

Gets the bounds of the tile overlay.

TileOverlay(string name)
The TileOverlay constructor.
setName(string name)
Sets a new name to the tile overlay.
setDomElement(DomElement domElement)
Sets the dom element of the tile overlay to be presented.
DomElement getDomElement()
Returns the dom element of the tile overlay.
t.addTileOverlayToScreen=function(tile overlay,
_anchor,
screenCoordinate,
zIndex)
Adds an tile overlay on top of the map referenced to the client screen.
The tile overlay position is fixed to screen (it won’t move in any map dragging).
The anchor and the offsetPosition parameters are used to determine alignment of the tile overlay above the map.
The offsetPosition is relative to the given anchor.
t.addTileOverlayToMap=function(tile overlay,
mapCoordinate,
centerMap,
zIndex)
Adds an tile overlay on top of the map referenced to the Map.
The ScreenPoint class represent a point on the viewport of the map by an X and Y coordinate in pixels.