Packagecom.esri.ags.layers
Classpublic class ArcGISImageServiceLayer
InheritanceArcGISImageServiceLayer Inheritance DynamicMapServiceLayer Inheritance Layer Inheritance mx.core.UIComponent

Allows you to work with an Image Service resource exposed by the ArcGIS Server REST API (available in ArcGIS Server 9.3 and above). Image Service is new in ArcGIS 9.3 and is a lighter-weight service optimized for delivering raw or finished imagery that can be RGB, panchromatic, multispectral, or elevation data stored in a geodatabase or file system. Data sources for Image Services can be raster datasets, in formats such as TIFF, MrSID, IMAGINE (IMG), or JPEG2000, as well as raster mosaics.

See also

com.esri.ags.events.LayerEvent
http://resources.esri.com/help/9.3/arcgisserver/apis/rest/index.html?imageserver.html
Publishing Image Services (.net)
Publishing Image Services (Java)

Public Properties
 PropertyDefined by
  bandCount : Number
[read-only] Number of bands in ArcGISImageServiceLayer.
ArcGISImageServiceLayer
  bandIds : Array
If there are multiple bands, you can either specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number, for example, [2, 1, 3].
ArcGISImageServiceLayer
  compressionQuality : Number
Controls how much loss the image will be subjected to by the compression algorithm.
ArcGISImageServiceLayer
  copyright : String
[read-only] Map copyright as defined by the map service.
ArcGISImageServiceLayer
  description : String
[read-only] Map description as defined by the map service.
ArcGISImageServiceLayer
  disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from being loaded from the browser's cache.
ArcGISImageServiceLayer
  imageFormat : String
The output image type.
ArcGISImageServiceLayer
  initialExtent : Extent
[read-only] Initial extent as defined by the image service.
ArcGISImageServiceLayer
  interpolation : String
The resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.
ArcGISImageServiceLayer
 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
  maxBandValues : Array
[read-only] Contains array of Numbers where each index represents a single band.
ArcGISImageServiceLayer
  maxPixelSize : Number
[read-only] The maximum pixel size.
ArcGISImageServiceLayer
 InheritedmaxScale : Number = 0
The maximum scale of the layer [added in version 1.3].
Layer
  meanBandValues : Array
[read-only] Contains array of Numbers where each index represents a single band.
ArcGISImageServiceLayer
  minBandValues : Array
[read-only] Contains array of Numbers where each index represents a single band.
ArcGISImageServiceLayer
  minPixelSize : Number
[read-only] The minimum pixel size.
ArcGISImageServiceLayer
 InheritedminScale : Number = 0
The minimum scale of the layer [added in version 1.3].
Layer
  pixelSizeX : Number
[read-only] Size of pixel in X direction.
ArcGISImageServiceLayer
  pixelSizeY : Number
[read-only] Size of pixel in Y direction.
ArcGISImageServiceLayer
  pixelType : String
[read-only] The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.
ArcGISImageServiceLayer
  proxyURL : String
The URL to proxy the request through.
ArcGISImageServiceLayer
  requestTimeout : Number = -1
The request timeout in seconds.
ArcGISImageServiceLayer
  serviceDataType : String
[read-only]
ArcGISImageServiceLayer
  serviceDescription : String
[read-only] Map service description as defined by the map service.
ArcGISImageServiceLayer
  spatialReference : SpatialReference
[read-only] The spatial reference of the image service.
ArcGISImageServiceLayer
  stdvBandValues : Array
[read-only] Contains array of Numbers where each index represents a single band.
ArcGISImageServiceLayer
  token : String
Token for accessing a secure ArcGIS Image service.
ArcGISImageServiceLayer
  units : String
The units of the layer.
ArcGISImageServiceLayer
  url : String
URL endpoint of an image service.
ArcGISImageServiceLayer
Public Methods
 MethodDefined by
  
ArcGISImageServiceLayer(url:String = null, proxyURL:String = null, token:String = null)
Creates a new ArcGISImageServiceLayer.
ArcGISImageServiceLayer
  
exportMapImage(imageServiceParameters:ImageServiceParameters = null, responder:IResponder = null):void
Exports a map image using values from the layer as defaults.
ArcGISImageServiceLayer
 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
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
loadMapImage(loader:Loader):void
Subclasses must override this method.
DynamicMapServiceLayer
 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
 EventSummaryDefined by
 Inherited
complete
Dispatched when the download of the map image is complete.DynamicMapServiceLayer
 Inherited
ioError
Dispatched when an input/output error occurs when downloading the map image.DynamicMapServiceLayer
 Inherited
load
Fires after layer properties for the layer are successfully populated.Layer
 Inherited
loadError
Fires if the layer is unable to load.Layer
  
mapImageExport
Dispatched when the map image export is completed.ArcGISImageServiceLayer
Property detail
bandCountproperty
bandCount:Number  [read-only]

Number of bands in ArcGISImageServiceLayer.

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

Implementation
    public function get bandCount():Number
bandIdsproperty 
bandIds:Array  [read-write]

If there are multiple bands, you can either specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number, for example, [2, 1, 3].

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

Implementation
    public function get bandIds():Array
    public function set bandIds(value:Array):void
compressionQualityproperty 
compressionQuality:Number  [read-write]

Controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100.

The default value is undefined.

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

Implementation
    public function get compressionQuality():Number
    public function set compressionQuality(value:Number):void
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
disableClientCachingproperty 
disableClientCaching:Boolean  [read-write]

If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from being loaded from the browser's cache.

The default value is false.

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

Implementation
    public function get disableClientCaching():Boolean
    public function set disableClientCaching(value:Boolean):void
imageFormatproperty 
imageFormat:String  [read-write]

The output image type. Valid types are: png8 | png24 | png32 | jpg | gif.

The default value is png8.

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

Initial extent as defined by the image service. Used for the map if it's 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
interpolationproperty 
interpolation:String  [read-write]

The resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space. Valid values are: RSP_BilinearInterpolation | RSP_CubicConvolution | RSP_Majority | RSP_NearestNeighbor

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

Implementation
    public function get interpolation():String
    public function set interpolation(value:String):void
maxBandValuesproperty 
maxBandValues:Array  [read-only]

Contains array of Numbers where each index represents a single band.

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

Implementation
    public function get maxBandValues():Array

See also

minBandValues
meanBandValues
stdvBandValues
maxPixelSizeproperty 
maxPixelSize:Number  [read-only]

The maximum pixel size.

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

Implementation
    public function get maxPixelSize():Number
meanBandValuesproperty 
meanBandValues:Array  [read-only]

Contains array of Numbers where each index represents a single band.

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

Implementation
    public function get meanBandValues():Array

See also

minBandValues
maxBandValues
stdvBandValues
minBandValuesproperty 
minBandValues:Array  [read-only]

Contains array of Numbers where each index represents a single band.

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

Implementation
    public function get minBandValues():Array

See also

maxBandValues
meanBandValues
stdvBandValues
minPixelSizeproperty 
minPixelSize:Number  [read-only]

The minimum pixel size.

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

Implementation
    public function get minPixelSize():Number
pixelSizeXproperty 
pixelSizeX:Number  [read-only]

Size of pixel in X direction.

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

Implementation
    public function get pixelSizeX():Number

See also

pixelSizeY
pixelSizeYproperty 
pixelSizeY:Number  [read-only]

Size of pixel in Y direction.

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

Implementation
    public function get pixelSizeY():Number

See also

pixelSizeX
pixelTypeproperty 
pixelType:String  [read-only]

The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.

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

Implementation
    public function get pixelType():String
proxyURLproperty 
proxyURL:String  [read-write]

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 
public var requestTimeout:Number = -1

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

serviceDataTypeproperty 
serviceDataType:String  [read-only]

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

Implementation
    public function get serviceDataType():String
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]

The spatial reference of the image service.

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

Implementation
    public function get spatialReference():SpatialReference
stdvBandValuesproperty 
stdvBandValues:Array  [read-only]

Contains array of Numbers where each index represents a single band.

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

Implementation
    public function get stdvBandValues():Array

See also

minBandValues
maxBandValues
meanBandValues
tokenproperty 
public var token:String

Token for accessing a secure ArcGIS Image service.

unitsproperty 
units:String  [read-write]

The units of the layer. If the layer is the basemap, the map is in these units.

The default value is UNKNOWN_UNITS.

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

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

See also

com.esri.ags.Units
urlproperty 
url:String  [read-write]

URL endpoint of an image service. To obtain the URL, use ArcGIS Services Directory.

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

Implementation
    public function get url():String
    public function set url(value:String):void
Constructor detail
ArcGISImageServiceLayer()constructor
public function ArcGISImageServiceLayer(url:String = null, proxyURL:String = null, token:String = null)

Creates a new ArcGISImageServiceLayer.

Parameters
url:String (default = null) — URL to the ArcGIS Server REST resource that represents an image service.
 
proxyURL:String (default = null) — The URL to proxy the request through.
 
token:String (default = null) — Token for accessing a secure ArcGIS Image service.
Method detail
exportMapImage()method
public function exportMapImage(imageServiceParameters:ImageServiceParameters = null, responder:IResponder = null):void

Exports a map image using values from the layer as defaults. On completion, MapImage is returned. The mapImageExport event is also fired.

Parameters
imageServiceParameters:ImageServiceParameters (default = null) — Input parameters to use when exporting the map image. Non-null properties override the layer's values.
 
responder:IResponder (default = null) — IResponder to pass the MapImage result to.

See also

MapImage
Event detail
mapImageExportevent 
Event object type: com.esri.ags.events.MapImageEvent
MapImageEvent.type property = com.esri.ags.events.MapImageEvent.EXPORT

Dispatched when the map image export is completed.

Defines the value of the type property of a mapImageExport event object.




(c) 2009 ESRI. All rights reserved.