Packagecom.esri.ags.layers
Classpublic class TiledMapServiceLayer
InheritanceTiledMapServiceLayer Inheritance Layer Inheritance mx.core.UIComponent
SubclassesArcGISTiledMapServiceLayer, VETiledLayer

Base class for all tiled layers that can be added to a map.

See also

LOD
TileInfo
com.esri.ags.events.LayerEvent


Public Properties
 PropertyDefined by
  displayLevels : Array
Levels to display in layer, based on LOD.level.
TiledMapServiceLayer
  fadeInFrameCount : uint
The number of frames it will take for the tiles to fade in.
TiledMapServiceLayer
  fullExtent : Extent
[read-only] The full extent of the layer.
TiledMapServiceLayer
 InheritedinitialExtent : Extent
The initial extent of the layer.
Layer
 InheritedisInScaleRange : Boolean
Returns true if the current scale of the map is between the maximum and minimum scale of the layer [added in version 1.3].
Layer
 Inheritedloaded : Boolean
When the layer is loaded, the value becomes "true" and layer properties can be accessed.
Layer
 Inheritedmap : Map
A reference to the Map this layer is in.
Layer
 InheritedmaxScale : Number = 0
The maximum scale of the layer [added in version 1.3].
Layer
 InheritedminScale : Number = 0
The minimum scale of the layer [added in version 1.3].
Layer
 InheritedspatialReference : SpatialReference
The spatial reference of the layer.
Layer
  tileInfo : TileInfo
[read-only] Contains information about the tiling scheme.
TiledMapServiceLayer
 Inheritedunits : String
The units of the layer.
Layer
Public Methods
 MethodDefined by
  
Creates a new TiledMapServiceLayer object.
TiledMapServiceLayer
 Inherited
refresh():void
Causes the layer to redraw or reload its content.
Layer
Protected Methods
 MethodDefined by
 Inherited
Adds listeners for ExtentEvent.EXTENT_CHANGE, ZoomEvent.ZOOM_START, ZoomEvent.ZOOM_UPDATE and ZoomEvent.ZOOM_END.
Layer
 Inherited
When an EXTENT_CHANGE event occurs, this calls invalidateLayer();
Layer
  
getTileURL(level:Number, row:Number, col:Number):URLRequest
Subclasses must override this method to cause tiles to be loaded from their own endpoints.
TiledMapServiceLayer
 Inherited
hideHandler(event:FlexEvent):void
When the layer is hidden (visible is set to false), this calls removeMapListeners().
Layer
 Inherited
Subclasses should call this whenever they would like to have updateLayer() called on them.
Layer
 Inherited
Removes all the layers children.
Layer
 Inherited
Removes the four event listeners added by addMapListeners();
Layer
 Inherited
setLoaded(value:Boolean):void
Subclasses must call this when they've loaded all their properties and are ready to load their content.
Layer
 Inherited
showHandler(event:FlexEvent):void
When the layer is shown (visible is set to true), this calls addMapListeners() and invalidateLayer().
Layer
 Inherited
toScreenX(mapX:Number):Number
Converts the x-coordinate of map point to a screen point.
Layer
 Inherited
toScreenY(mapY:Number):Number
Converts the y-coordinate of map point to a screen point.
Layer
 Inherited
updateLayer():void
Subclasses must override this method.
Layer
 Inherited
Finishes the zoom animation.
Layer
 Inherited
Prepares the zoom animation by taking a bitmap of the layer.
Layer
 Inherited
Redraws the bitmap of the layer.
Layer
Events
 EventSummaryDefined by
   Dispatched when a tile's content loading is complete and the tile has finished fading in.TiledMapServiceLayer
   Dispatched when a tile input/output error occurs.TiledMapServiceLayer
 Inherited Fires after layer properties for the layer are successfully populated.Layer
 Inherited Fires if the layer is unable to load.Layer
   Dispatched when all the tiles have either been completed or have errored.TiledMapServiceLayer
Property detail
displayLevelsproperty
displayLevels:Array  [read-write]

Levels to display in layer, based on LOD.level. If null, all levels are displayed.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get displayLevels():Array
    public function set displayLevels(value:Array):void
fadeInFrameCountproperty 
fadeInFrameCount:uint  [read-write]

The number of frames it will take for the tiles to fade in. They will only fade in if this is greater than one.

Note: the fadeInFrameCount property was added in version 1.1 of the ArcGIS API for Flex.

The default value is 4.

This property can be used as the source for data binding.

Implementation
    public function get fadeInFrameCount():uint
    public function set fadeInFrameCount(value:uint):void
fullExtentproperty 
fullExtent:Extent  [read-only]

The full extent of the layer. Subclasses must override this method.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get fullExtent():Extent
tileInfoproperty 
tileInfo:TileInfo  [read-only]

Contains information about the tiling scheme. Subclasses must override this method.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get tileInfo():TileInfo
Constructor detail
TiledMapServiceLayer()constructor
public function TiledMapServiceLayer()

Creates a new TiledMapServiceLayer object.

Method detail
getTileURL()method
protected function getTileURL(level:Number, row:Number, col:Number):URLRequest

Subclasses must override this method to cause tiles to be loaded from their own endpoints.

Parameters
level:Number — The tile level.
 
row:Number — The tile row.
 
col:Number — The tile column.

Returns
URLRequest — The URLRequest to be used to load the tile.

See also

Event detail
completeevent 
Event object type: flash.events.Event

Dispatched when a tile's content loading is complete and the tile has finished fading in.

ioErrorevent  
Event object type: flash.events.IOErrorEvent

Dispatched when a tile input/output error occurs.

tilesUpdatedevent  
Event object type: com.esri.ags.events.LayerEvent
LayerEvent.type property = com.esri.ags.events.LayerEvent.TILES_UPDATED

Dispatched when all the tiles have either been completed or have errored. This is also dispatched if no new tiles need to be loaded.

Note: the tilesUpdated event was added in version 1.1 of the ArcGIS API for Flex.

Defines the value of the type property of the event object for a tilesUpdated event.