com.esri.ags.layers.ArcGISImageServiceLayer

	Property	Defined 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
		fields : Array [read-only] The fields of the image service as specified in the Service Directory.	ArcGISImageServiceLayer
		imageFormat : String The output image type.	ArcGISImageServiceLayer
		initialExtent : Extent [override] [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
		isInScaleRange : 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
		loaded : Boolean [read-only] When the layer is loaded, the value becomes "true" and layer properties can be accessed.	Layer
		loadFault : Fault [read-only] A reference to the fault that is dispatched when the layer throws a loadError event.	Layer
		map : Map [read-only] 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
		maxScale : Number 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
		minScale : Number The minimum scale of the layer [added in version 1.3].	Layer
		mosaicRule : MosaicRule Specifies the mosaic rule when defining how individual images should be mosaicked.	ArcGISImageServiceLayer
		noData : Number The pixel value representing no information.	ArcGISImageServiceLayer
		objectIdField : String [read-only] The name of the object ID field.	ArcGISImageServiceLayer
		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
		renderingRule : RasterFunction Specifies the rendering rule for how the requested image should be rendered.	ArcGISImageServiceLayer
		requestTimeout : int 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 [override] [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
		timeInfo : TimeInfo [read-only] Only the TimeInfo's timeExtent and timeReference properties may be available [added in version 2.0].	ArcGISImageServiceLayer
		timeOffset : Number The time offset for the layer [added in version 2.0].	ArcGISImageServiceLayer
		timeOffsetUnits : String The units of the timeOffset [added in version 2.0].	ArcGISImageServiceLayer
		token : String Token for accessing a secure ArcGIS Image service.	ArcGISImageServiceLayer
		units : String [override] The units of the layer.	ArcGISImageServiceLayer
		url : String URL endpoint of an image service.	ArcGISImageServiceLayer
		useMapTime : Boolean If true and the image service is time aware, a new image will be requested whenever the map's timeExtent changes.	ArcGISImageServiceLayer
		version : Number [read-only] The version of ArcGIS Server where the image service is published to, for example, 9.3, 9.31, 10, 10.01 or 10.1.	ArcGISImageServiceLayer

	Method	Defined By
		ArcGISImageServiceLayer(url:String = null, proxyURL:String = null, token:String = null) Creates a new ArcGISImageServiceLayer.	ArcGISImageServiceLayer
		exportMapImage(imageServiceParameters:ImageServiceParameters = null, responder:IResponder = null):AsyncToken Exports a map image using values from the layer as defaults.	ArcGISImageServiceLayer
		refresh():void Causes the layer to redraw or reload its content.	Layer

	Method	Defined By
		addMapListeners():void Adds listeners for ExtentEvent.EXTENT_CHANGE, ZoomEvent.ZOOM_START, ZoomEvent.ZOOM_UPDATE and ZoomEvent.ZOOM_END.	Layer
		extentChangeHandler(event:ExtentEvent):void When an EXTENT_CHANGE event occurs, this calls invalidateLayer();	Layer
		hideHandler(event:FlexEvent):void When the layer is hidden (visible is set to false), this calls removeMapListeners().	Layer
		invalidateLayer():void Subclasses should call this whenever they would like to have updateLayer() called on them.	Layer
		loadMapImage(loader:Loader):void Subclasses must override this method.	DynamicMapServiceLayer
		removeAllChildren():void Removes all the layers children.	Layer
		removeMapListeners():void Removes the four event listeners added by addMapListeners();	Layer
		setLoaded(value:Boolean):void Subclasses must call this when they've loaded all their properties and are ready to load their content.	Layer
		showHandler(event:FlexEvent):void When the layer is shown (visible is set to true), this calls addMapListeners() and invalidateLayer().	Layer
		toScreenX(mapX:Number):Number Converts the x-coordinate of map point to a screen point.	Layer
		toScreenY(mapY:Number):Number Converts the y-coordinate of map point to a screen point.	Layer
		updateLayer():void Subclasses must override this method.	Layer
		zoomEndHandler(event:ZoomEvent):void Finishes the zoom animation.	Layer
		zoomStartHandler(event:ZoomEvent):void Prepares the zoom animation by taking a bitmap of the layer.	Layer
		zoomUpdateHandler(event:ZoomEvent):void Redraws the bitmap of the layer.	Layer

Summary	Defined By
fault	Dispatched when an exportMapImage operation fails.	ArcGISImageServiceLayer
isInScaleRangeChange	Fires if the value of isInScaleRange changes.	Layer
load	Fires after layer properties for the layer are successfully populated.	Layer
loadError	Fires if the layer is unable to load.	Layer
mapImageExport	Dispatched when an exportMapImage operation successfully completes.	ArcGISImageServiceLayer
updateEnd	Fires when the layer has finished updating its content.	Layer
updateStart	Fires when the layer begins to update its content.	Layer

Property Detail

bandCount

property

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

bandIds

property

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].

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

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

compressionQuality

property

compressionQuality:Number

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

property

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

description

property

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

disableClientCaching

property

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.

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

fields

property

fields:Array [read-only]

The fields of the image service as specified in the Service Directory.

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

Implementation
public function get fields():Array

imageFormat

property

imageFormat:String

The output image type. Valid types are: jpgpng | png8 | png24 | png32 | jpg | gif. Note that support for the jpgpng format was added at ArcGIS Server 10.0. This format returns a JPG if there are no transparent pixels in the requested extent, otherwise it returns a PNG.

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

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

initialExtent

property

initialExtent:Extent [read-only] [override]

Initial extent as defined by the image 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

interpolation

property

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. 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

maxBandValues

property

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

maxPixelSize

property

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

meanBandValues

property

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

minBandValues

property

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

minPixelSize

property

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

mosaicRule

property

mosaicRule:MosaicRule

Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset.

the selection of rasters that will participate in the mosaic (using where clause);
the mosaic method, for example, how the selected rasters are ordered;
the mosaic operation, for example, how overlapping pixels at the same location are resolved.

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

Implementation
public function get mosaicRule():MosaicRule
public function set mosaicRule(value:MosaicRule):void

noData

property

noData:Number

The pixel value representing no information.

The default value is undefined.

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

Implementation
public function get noData():Number
public function set noData(value:Number):void

objectIdField

property

objectIdField:String [read-only]

The name of the object ID field.

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

Implementation
public function get objectIdField():String

pixelSizeX

property

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

property

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

pixelType

property

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

proxyURL

property

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

renderingRule

property

renderingRule:RasterFunction

Specifies the rendering rule for how the requested image should be rendered.

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

Implementation
public function get renderingRule():RasterFunction
public function set renderingRule(value:RasterFunction):void

requestTimeout

property

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

serviceDataType

property

serviceDataType:String [read-only]

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

Implementation
public function get serviceDataType():String

serviceDescription

property

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

spatialReference

property

spatialReference:SpatialReference [read-only] [override]

The spatial reference of the image service.

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

Implementation
public function get spatialReference():SpatialReference

stdvBandValues

property

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

timeInfo

property

timeInfo:TimeInfo [read-only]

Only the TimeInfo's 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

timeOffset

property

timeOffset:Number

The time offset for the layer [added in version 2.0].

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

Implementation
public function get timeOffset():Number
public function set timeOffset(value:Number):void

timeOffsetUnits

property

timeOffsetUnits:String

The units of the timeOffset [added in version 2.0].

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

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

token

property

token:String

Token for accessing a secure ArcGIS Image 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

units

property

units:String[override]

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

url

property

url:String

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

useMapTime

property

useMapTime:Boolean

Since :

ArcGIS API for Flex 2.2

If true and the image service is time aware, a new image will be requested whenever the map's timeExtent changes.

The default value is true.

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

Implementation
public function get useMapTime():Boolean
public function set useMapTime(value:Boolean):void

version

property

version:Number [read-only]

Since :

ArcGIS API for Flex 2.2

The version of ArcGIS Server where the image 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

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):AsyncToken

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.

Returns

AsyncToken

Event Detail

fault

Event

Event Object Type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

Dispatched when an exportMapImage operation fails.

mapImageExport

Event

Event Object Type: com.esri.ags.events.MapImageEvent
MapImageEvent.type property = com.esri.ags.events.MapImageEvent.EXPORT

Dispatched when an exportMapImage operation successfully completes.

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

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

ArcGIS API for Flex 2.5	All Packages \| All Classes \| Index \| Frames No Frames
ArcGISImageServiceLayer	Properties \| Methods \| Events

Package	com.esri.ags.layers
Class	public class ArcGISImageServiceLayer
Inheritance	ArcGISImageServiceLayer DynamicMapServiceLayer Layer mx.core.UIComponent