Packagecom.esri.ags.layers
Classpublic class WMTSLayer
InheritanceWMTSLayer Inheritance TiledMapServiceLayer Inheritance Layer Inheritance mx.core.UIComponent

Since : ArcGIS API for Flex 2.5

The WMTSLayer class is used to create a layer based on an OGC Web Map Tile Service layer.

Tip: If the WMTS server doesn't have a crossdomain.xml file, you can use a proxy


Public Properties
 PropertyDefined By
  abstract : String
The abstract for the web map tile service.
WMTSLayer
  copyright : String
The copyright of the web map tile service.
WMTSLayer
 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] Full extent as defined by the web map tile service.
WMTSLayer
  imageFormat : String
The output image format.
WMTSLayer
  initialExtent : Extent
[override] Initial extent as defined by the web map tile service.
WMTSLayer
 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
  layerId : String
Gets or sets the layer to be displayed [optional].
WMTSLayer
 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.
WMTSLayer
  serviceMode : String
Gets or sets the WMTS service mode [optional].
WMTSLayer
  spatialReference : SpatialReference
[override] [read-only] The spatial reference of the web map tile service.
WMTSLayer
 InheritedtileInfo : TileInfo
[read-only] Contains information about the tiling scheme.
TiledMapServiceLayer
  tileMatrixSetId : String
Gets or sets the tile matrix set being used [optional].
WMTSLayer
  title : String
The title for the WMTS service.
WMTSLayer
 Inheritedunits : String
[read-only] The units of the layer.
Layer
  url : String
Gets or sets the URL to a web map tile service endpoint [required].
WMTSLayer
  version : String
[read-only] Returns 1.0.0
WMTSLayer
Public Methods
 MethodDefined By
  
WMTSLayer(url:String = null, proxyURL:String = null)
Creates a new WMTSLayer object.
WMTSLayer
 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
 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
abstractproperty
abstract:String

The abstract for the web map tile service.

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


Implementation
    public function get abstract():String
    public function set abstract(value:String):void
copyrightproperty 
copyright:String

The copyright of the web map tile service.

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


Implementation
    public function get copyright():String
    public function set copyright(value:String):void
fullExtentproperty 
fullExtent:Extent[override]

Full extent as defined by the web map tile service.

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


Implementation
    public function get fullExtent():Extent
    public function set fullExtent(value:Extent):void
imageFormatproperty 
imageFormat:String

The output image format.

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


Implementation
    public function get imageFormat():String
    public function set imageFormat(value:String):void
initialExtentproperty 
initialExtent:Extent[override]

Initial extent as defined by the web map tile service. Used by 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
    public function set initialExtent(value:Extent):void
layerIdproperty 
layerId:String

Gets or sets the layer to be displayed [optional].

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


Implementation
    public function get layerId():String
    public function set layerId(value:String):void
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
serviceModeproperty 
serviceMode:String

Gets or sets the WMTS service mode [optional]. If the specified mode does not match the service the WMTS layer will not be created. Allowed values are "KVP" or "RESTful".

The default value is "RESTful".

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


Implementation
    public function get serviceMode():String
    public function set serviceMode(value:String):void
spatialReferenceproperty 
spatialReference:SpatialReference  [read-only] [override]

The spatial reference of the web map tile service.

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


Implementation
    public function get spatialReference():SpatialReference
tileMatrixSetIdproperty 
tileMatrixSetId:String

Gets or sets the tile matrix set being used [optional].

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


Implementation
    public function get tileMatrixSetId():String
    public function set tileMatrixSetId(value:String):void
titleproperty 
title:String

The title for the WMTS service.

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


Implementation
    public function get title():String
    public function set title(value:String):void
urlproperty 
url:String

Gets or sets the URL to a web map tile service endpoint [required].

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:String  [read-only]

Returns 1.0.0


Implementation
    public function get version():String
Constructor Detail
WMTSLayer()Constructor
public function WMTSLayer(url:String = null, proxyURL:String = null)

Creates a new WMTSLayer object.

Parameters
url:String (default = null) — URL to the WMTS resource.
 
proxyURL:String (default = null) — The URL to proxy the request through.



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

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