Packagecom.google.maps.overlays
Classpublic class TileLayerOverlay
Implementsflash.events.IEventDispatcher, ITileLayerOverlay

TileLayerOverlay is a type of overlay that adds a custom layer of tiles to the map on top of the MapType-specific tile layers.



Public Properties
 PropertyDefined by
  foreground : DisplayObject
[read-only] Display object that represents the overlay's content.
TileLayerOverlay
  pane : IPane
Pane this overlay resides on (null if the overlay is not added to the map).
TileLayerOverlay
  projection : IProjection
[read-only] Projection used for calculating positions of tiles.
TileLayerOverlay
  shadow : DisplayObject
[read-only] Display object that represents the overlay's shadow (null if the overlay never has a shadow).
TileLayerOverlay
  tileLayer : ITileLayer
[read-only] Tile layer used for the overlay.
TileLayerOverlay
  tileSize : int
[read-only] Tile size.
TileLayerOverlay
  visible : Boolean
Visibility of the overlay.
TileLayerOverlay
Public Methods
 MethodDefined by
  
TileLayerOverlay(tileLayer:ITileLayer, tileSize:int = 256, projection:IProjection = null)
TileLayerOverlay constructor.
TileLayerOverlay
  
Retrieves the default pane that this overlay should be placed on if none is explicitly specified (when the overlay is added through the IMap.addOverlay() call).
TileLayerOverlay
  
positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen.
TileLayerOverlay
Protected Methods
 MethodDefined by
  
clearWrapper():void
Remove all event listeners and clear the wrapper.
TileLayerOverlay
Property detail
foregroundproperty
foreground:DisplayObject  [read-only]

Display object that represents the overlay's content.

Implementation
    public function get foreground():DisplayObject
paneproperty 
pane:IPane  [read-write]

Pane this overlay resides on (null if the overlay is not added to the map). This property value is set by the map when the overlay is added to or removed from the map and should not be modified by the developers.

Implementation
    public function get pane():IPane
    public function set pane(value:IPane):void
projectionproperty 
projection:IProjection  [read-only]

Projection used for calculating positions of tiles.

Implementation
    public function get projection():IProjection
shadowproperty 
shadow:DisplayObject  [read-only]

Display object that represents the overlay's shadow (null if the overlay never has a shadow).

Implementation
    public function get shadow():DisplayObject
tileLayerproperty 
tileLayer:ITileLayer  [read-only]

Tile layer used for the overlay.

Implementation
    public function get tileLayer():ITileLayer
tileSizeproperty 
tileSize:int  [read-only]

Tile size.

Implementation
    public function get tileSize():int
visibleproperty 
visible:Boolean  [read-write]

Visibility of the overlay.

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor detail
TileLayerOverlay()constructor
public function TileLayerOverlay(tileLayer:ITileLayer, tileSize:int = 256, projection:IProjection = null)

TileLayerOverlay constructor.

Parameters
tileLayer:ITileLayer — Tile layer used by the overlay.
 
tileSize:int (default = 256) — Tile size (256 by default).
 
projection:IProjection (default = null) — Projection used by the overlay (If not set, Mercator projection by will be used by default).
Method detail
clearWrapper()method
protected function clearWrapper():void

Remove all event listeners and clear the wrapper.

getDefaultPane()method 
public function getDefaultPane(map:IMap):IPane

Retrieves the default pane that this overlay should be placed on if none is explicitly specified (when the overlay is added through the IMap.addOverlay() call).

Parameters
map:IMap — Instance of map that this overlay is added to.

Returns
IPane — Instance of IPane to which the overlay will be added by default.
positionOverlay()method 
public function positionOverlay(zoomChanged:Boolean):void

Reposition the overlay on the screen. This method is called in response to changes in the position (centre) of the map and/or the map's zoom level. Developers should not call the method themselves. The implementation of this method should either change the position of the overlay on the screen in response to the change of the map's centre or redraw the overlay completely if it needs to be reconfigured for a different map centre/zoom level. Repositioning of the overlay should be done by changing the placement of the overlay's display object on its pane using the mappings provided by the IPane interface (fromLatLngToPaneCoords or fromProjectionPointToPaneCoords).

Parameters
zoomChanged:Boolean — Whether the zoom level of the map has changed or the call was invoked just as a result of a map pan.