Packagecom.esri.ags.layers
Classpublic class ArcGISTiledMapServiceLayer
InheritanceArcGISTiledMapServiceLayer Inheritance TiledMapServiceLayer Inheritance Layer Inheritance mx.core.UIComponent
Implements ILegendSupport

Allows you to work with a cached map service resource exposed by the ArcGIS Server REST API (available in ArcGIS Server 9.3 and above). A cached service accesses pre-created tiles from a cache instead of dynamically rendering images.

The projection of the map is determined by the first visible layer. The tiling scheme (scale levels) is determined by the first ArcGISTiledMapServiceLayer.

Note that ArcGISTiledMapServiceLayer, like all layers, extend UIComponent and thus include basic mouse events, for example: click, mouseOut, mouseOver, and mouseDown, as well as other events like show and hide, and general properties, such as alpha and visible.

View the examples

See also

com.esri.ags.events.LayerEvent
Directory of services from ArcGIS Online
Live sample - World Topographic Map

Public Properties
 PropertyDefined By
  capabilities : Array
[read-only] Capabilities of the map service, possible array values are Map, Query, and Data.
ArcGISTiledMapServiceLayer
  copyright : String
[read-only] Map copyright as defined by the map service.
ArcGISTiledMapServiceLayer
  description : String
[read-only] Map description as defined by the map service.
ArcGISTiledMapServiceLayer
 InheriteddisplayLevels : Array
Levels to display in layer, based on LOD.level.
TiledMapServiceLayer
 InheritedfadeInFrameCount : uint
The number of frames it will take for the tiles to fade in.
TiledMapServiceLayer
  fullExtent : Extent
[override] [read-only] Full extent as defined by the map service.
ArcGISTiledMapServiceLayer
  initialExtent : Extent
[override] [read-only] Initial extent as defined by the map service.
ArcGISTiledMapServiceLayer
 InheritedisInScaleRange : Boolean
[read-only] 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
  layerInfos : Array
[read-only] The available layers in the map service and their default visibility.
ArcGISTiledMapServiceLayer
  layerInfoWindowRenderers : Array
Array of LayerInfoWindowRenderers that allow you to define infoWindowRenderers for specific layers [added in version 2.3].
ArcGISTiledMapServiceLayer
 Inheritedloaded : Boolean
[read-only] When the layer is loaded, the value becomes "true" and layer properties can be accessed.
Layer
 InheritedloadFault : Fault
[read-only] A reference to the fault that is dispatched when the layer throws a loadError event.
Layer
 Inheritedmap : Map
[read-only] A reference to the Map this layer is in.
Layer
 InheritedmaxScale : Number
The maximum scale of the layer [added in version 1.3].
Layer
 InheritedminScale : Number
The minimum scale of the layer [added in version 1.3].
Layer
  proxyURL : String
The URL to proxy the request through.
ArcGISTiledMapServiceLayer
  requestTimeout : int
The request timeout in seconds.
ArcGISTiledMapServiceLayer
  serviceDescription : String
[read-only] Map service description as defined by the map service.
ArcGISTiledMapServiceLayer
  spatialReference : SpatialReference
[override] [read-only] The spatial reference of the map service.
ArcGISTiledMapServiceLayer
  tableInfos : Array
[read-only] The stand-alone tables in the map service [added in version 2.0].
ArcGISTiledMapServiceLayer
  tileInfo : TileInfo
[override] [read-only] Contains information about the tiling scheme.
ArcGISTiledMapServiceLayer
  tileServers : Array
List of URL endpoints to load from.
ArcGISTiledMapServiceLayer
  timeInfo : TimeInfo
[read-only] Only timeExtent and timeReference properties may be available [added in version 2.0].
ArcGISTiledMapServiceLayer
  token : String
Token for accessing a secure tiled ArcGIS service.
ArcGISTiledMapServiceLayer
  units : String
[override] [read-only] The units of the layer.
ArcGISTiledMapServiceLayer
  url : String
URL endpoint of a service.
ArcGISTiledMapServiceLayer
  version : Number
[read-only] The version of ArcGIS Server where the map service is published to, for example, 9.3, 9.31, 10, 10.01 or 10.1.
ArcGISTiledMapServiceLayer
  visibleLayers : ArrayCollection
[read-only] The visible layers as defined by the default visibility in LayerInfo.
ArcGISTiledMapServiceLayer
Public Methods
 MethodDefined By
  
ArcGISTiledMapServiceLayer(url:String = null, proxyURL:String = null, token:String = null)
Creates a new ArcGISTiledMapServiceLayer object.
ArcGISTiledMapServiceLayer
  
getAllDetails(responder:IResponder = null):AsyncToken
Gets the detailed information for all the ArcGIS layers and tables in the service.
ArcGISTiledMapServiceLayer
  
getDetails(layerOrTableId:Number, responder:IResponder = null):AsyncToken
Gets the detailed information for an ArcGIS layer or table.
ArcGISTiledMapServiceLayer
  
getLegendInfos(responder:IResponder = null):AsyncToken
Gets legend infos.
ArcGISTiledMapServiceLayer
 Inherited
refresh():void
Causes the layer to redraw or reload its content.
Layer
Protected Methods
 MethodDefined By
 Inherited
addMapListeners():void
Adds listeners for ExtentEvent.EXTENT_CHANGE, ZoomEvent.ZOOM_START, ZoomEvent.ZOOM_UPDATE and ZoomEvent.ZOOM_END.
Layer
 Inherited
extentChangeHandler(event:ExtentEvent):void
When an EXTENT_CHANGE event occurs, this calls invalidateLayer();
Layer
 Inherited
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
invalidateLayer():void
Subclasses should call this whenever they would like to have updateLayer() called on them.
Layer
 Inherited
removeAllChildren():void
Removes all the layers children.
Layer
 Inherited
removeMapListeners():void
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
zoomEndHandler(event:ZoomEvent):void
Finishes the zoom animation.
Layer
 Inherited
zoomStartHandler(event:ZoomEvent):void
Prepares the zoom animation by taking a bitmap of the layer.
Layer
 Inherited
zoomUpdateHandler(event:ZoomEvent):void
Redraws the bitmap of the layer.
Layer
Events
 Event Summary Defined By
  
fault
Dispatched when getAllDetails or getDetails operations fails.ArcGISTiledMapServiceLayer
  
getAllDetailsComplete
Dispatched when an getAllDetails operation successfully completes.ArcGISTiledMapServiceLayer
  
getDetailsComplete
Dispatched when an getDetails operation successfully completes.ArcGISTiledMapServiceLayer
 Inherited
isInScaleRangeChange
Fires if the value of isInScaleRange changes.Layer
 Inherited
load
Fires after layer properties for the layer are successfully populated.Layer
 Inherited
loadError
Fires if the layer is unable to load.Layer
 Inherited
updateEnd
Fires when the layer has finished updating its content.Layer
 Inherited
updateStart
Fires when the layer begins to update its content.Layer
Property Detail
capabilitiesproperty
capabilities:Array  [read-only]

Capabilities of the map service, possible array values are Map, Query, and Data.

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


Implementation
    public function get capabilities():Array
copyrightproperty 
copyright:String  [read-only]

Map copyright as defined by the map service.

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


Implementation
    public function get copyright():String
descriptionproperty 
description:String  [read-only]

Map description as defined by the map service.

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


Implementation
    public function get description():String
fullExtentproperty 
fullExtent:Extent  [read-only] [override]

Full extent as defined by the map service.

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


Implementation
    public function get fullExtent():Extent
initialExtentproperty 
initialExtent:Extent  [read-only] [override]

Initial extent as defined by the map service. Used for the map if it is the first layer in the map and map doesn't have an extent specified.

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


Implementation
    public function get initialExtent():Extent
layerInfosproperty 
layerInfos:Array  [read-only]

The available layers in the map service and their default visibility.

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


Implementation
    public function get layerInfos():Array

See also

com.esri.ags.layers.supportClasses.LayerInfo
layerInfoWindowRenderersproperty 
layerInfoWindowRenderers:Array

Since : ArcGIS API for Flex 2.3

Array of LayerInfoWindowRenderers that allow you to define infoWindowRenderers for specific layers [added in version 2.3].

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


Implementation
    public function get layerInfoWindowRenderers():Array
    public function set layerInfoWindowRenderers(value:Array):void

See also

com.esri.ags.layers.supportClasses.LayerInfoWindowRenderer
proxyURLproperty 
proxyURL:String

The URL to proxy the request through.

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


Implementation
    public function get proxyURL():String
    public function set proxyURL(value:String):void
requestTimeoutproperty 
requestTimeout:int

The request timeout in seconds. A value less than or equal to zero prevents request timeout.

The default value is -1.

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


Implementation
    public function get requestTimeout():int
    public function set requestTimeout(value:int):void
serviceDescriptionproperty 
serviceDescription:String  [read-only]

Map service description as defined by the map service.

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


Implementation
    public function get serviceDescription():String
spatialReferenceproperty 
spatialReference:SpatialReference  [read-only] [override]

The spatial reference of the map service.

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


Implementation
    public function get spatialReference():SpatialReference
tableInfosproperty 
tableInfos:Array  [read-only]

The stand-alone tables in the map service [added in version 2.0]. The TableInfo contains the id and name of each of these table.

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


Implementation
    public function get tableInfos():Array

See also

com.esri.ags.layers.supportClasses.TableInfo
tileInfoproperty 
tileInfo:TileInfo  [read-only] [override]

Contains information about the tiling scheme.

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


Implementation
    public function get tileInfo():TileInfo
tileServersproperty 
tileServers:Array

List of URL endpoints to load from. This improves performance by allowing more simultaneous requests.

Note: you can specify a single tile Server to override the URL used for tile requests.

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


Implementation
    public function get tileServers():Array
    public function set tileServers(value:Array):void

See also

http://en.wikipedia.org/wiki/Round_robin_DNS

Example
Using tile servers 
     <esri:ArcGISTiledMapServiceLayer url="http://mymaindomain/ArcGIS/rest/services/World_TilesOnDemand/MapServer">
         <esri:tileServers>
             <fx:String>http://tiles1.example.com/ArcGIS/rest/services/World_TilesOnDemand/MapServer</fx:String>
             <fx:String>http://tiles2.example.com/ArcGIS/rest/services/World_TilesOnDemand/MapServer</fx:String>
         </esri:tileServers>
     </esri:ArcGISTiledMapServiceLayer>
timeInfoproperty 
timeInfo:TimeInfo  [read-only]

Only timeExtent and timeReference properties may be available [added in version 2.0].

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


Implementation
    public function get timeInfo():TimeInfo
tokenproperty 
token:String

Token for accessing a secure tiled ArcGIS service.

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


Implementation
    public function get token():String
    public function set token(value:String):void

Example
Specifying the security token for a secured tile service 
     <esri:ArcGISTiledMapServiceLayer
         url="http://premium.arcgisonline.com/Server/rest/services/World_Imagery/MapServer?token=XXX-t0RZv0ViIuOqM80EKzQ2-0B3LYIgfPMbp4AMDsV5TDF1I14IkhD7JWx5jgzbwFIfxhXOniZCRZZZYYYXXX.."
         token="XXX-t0RZv0ViIuOqM80EKzQ2-0B3LYIgfPMbp4AMDsV5TDF1I14IkhD7JWx5jgzbwFIfxhXOniZCRZZZYYYXXX.." />
     </esri:Map>
unitsproperty 
units:String  [read-only] [override]

The units of the layer. Subclasses should override this method as a best practice in case a subclassed layer is added to a map which has different "units".

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


Implementation
    public function get units():String

See also

com.esri.ags.Units
urlproperty 
url:String

URL endpoint of a service. To obtain the URL, use ArcGIS Services Directory. An example URL for the Street Map service on ArcGIS Online is http://server.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.

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


Implementation
    public function get url():String
    public function set url(value:String):void
versionproperty 
version:Number  [read-only]

Since : ArcGIS API for Flex 2.2

The version of ArcGIS Server where the map service is published to, for example, 9.3, 9.31, 10, 10.01 or 10.1.

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


Implementation
    public function get version():Number
visibleLayersproperty 
visibleLayers:ArrayCollection  [read-only]

The visible layers as defined by the default visibility in LayerInfo.

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


Implementation
    public function get visibleLayers():ArrayCollection

See also

layerInfos
Constructor Detail
ArcGISTiledMapServiceLayer()Constructor
public function ArcGISTiledMapServiceLayer(url:String = null, proxyURL:String = null, token:String = null)

Creates a new ArcGISTiledMapServiceLayer object.

Parameters
url:String (default = null) — URL to the ArcGIS Server REST resource that represents a cached map service.
 
proxyURL:String (default = null) — The URL to proxy the request through.
 
token:String (default = null) — Token for accessing a secure tiled ArcGIS service.
Method Detail
getAllDetails()method
public function getAllDetails(responder:IResponder = null):AsyncToken

Since : ArcGIS API for Flex 2.0

Gets the detailed information for all the ArcGIS layers and tables in the service. On completion, an AllDetails object is returned. This requires ArcGIS Server 10.0 or above.

Parameters

responder:IResponder (default = null) — IResponder to pass the AllDetails result to.

Returns
AsyncToken

See also

com.esri.ags.layers.supportClasses.AllDetails
getDetails()method 
public function getDetails(layerOrTableId:Number, responder:IResponder = null):AsyncToken

Gets the detailed information for an ArcGIS layer or table. On completion, a LayerDetails is returned if layerOrTableId is a layer, or a TableDetails is returned if layerOrTableId is a table.

Parameters

layerOrTableId:Number — Layer ID or Table ID assigned by ArcGIS Server for a layer or table.
 
responder:IResponder (default = null) — IResponder to pass the LayerDetails or TableDetails result to.

Returns
AsyncToken

See also

com.esri.ags.layers.supportClasses.LayerDetails
com.esri.ags.layers.supportClasses.TableDetails
getLegendInfos()method 
public function getLegendInfos(responder:IResponder = null):AsyncToken

Gets legend infos.

Parameters

responder:IResponder (default = null) — The responder to call on result or fault. The result function will be given an Array of LayerLegendInfo instances.

Returns
AsyncToken —

See also

com.esri.ags.layers.supportClasses.LayerLegendInfo
Event Detail
fault Event
Event Object Type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

Dispatched when getAllDetails or getDetails operations fails.

getAllDetailsComplete Event  
Event Object Type: com.esri.ags.events.DetailsEvent
DetailsEvent.type property = com.esri.ags.events.DetailsEvent.GET_ALL_DETAILS_COMPLETE

Dispatched when an getAllDetails operation successfully completes.

Defines the value of the type property of an getAllDetailsComplete event object.
getDetailsComplete Event  
Event Object Type: com.esri.ags.events.DetailsEvent
DetailsEvent.type property = com.esri.ags.events.DetailsEvent.GET_DETAILS_COMPLETE

Dispatched when an getDetails operation successfully completes.

Defines the value of the type property of an getDetailsComplete event object.
Examples
MXML usage of ArcGISTiledMapServiceLayer: 
 <esri:Map>
     <esri:ArcGISTiledMapServiceLayer url="http://server.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer"/>
 </esri:Map>



© 2008-2011 Esri, Inc. All rights reserved.

Wed Nov 30 2011, 04:19 PM -08:00