Packagecom.esri.ags.layers
Classpublic class GPResultImageLayer
InheritanceGPResultImageLayer Inheritance DynamicMapServiceLayer Inheritance Layer Inheritance mx.core.UIComponent

Allows you to view a geoprocessing task result. In most cases you will not use this directly, but instead use Geoprocessor#getResultImageLayer which returns a GPResultImageLayer.

See also

com.esri.ags.tasks.Geoprocessor.getResultImageLayer()


Public Properties
 PropertyDefined by
  dpi : Number
The output dpi of the dynamic map service layer.
GPResultImageLayer
  imageFormat : String
The output image type.
GPResultImageLayer
  imageTransparency : Boolean
Whether or not the background of dynamic image is transparent.
GPResultImageLayer
 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
  jobId : String
The jobId returned from JobInfo.
GPResultImageLayer
 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
  parameterName : String
The name of the result parameter as defined in ArcGIS Services Directory.
GPResultImageLayer
  proxyURL : String
The URL to proxy the request through.
GPResultImageLayer
 InheritedspatialReference : SpatialReference
The spatial reference of the layer.
Layer
  token : String
Token for accessing a secure ArcGIS.
GPResultImageLayer
 Inheritedunits : String
The units of the layer.
Layer
  url : String
URL endpoint of a service.
GPResultImageLayer
Public Methods
 MethodDefined by
  
GPResultImageLayer(url:String = null)
Creates a new GPResultImageLayer object.
GPResultImageLayer
 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
 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
loadMapImage(loader:Loader):void
Subclasses must override this method.
DynamicMapServiceLayer
 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
 Inherited Dispatched when the download of the map image is complete.DynamicMapServiceLayer
 Inherited Dispatched when an input/output error occurs when downloading the map image.DynamicMapServiceLayer
 Inherited Fires after layer properties for the layer are successfully populated.Layer
 Inherited Fires if the layer is unable to load.Layer
Property detail
dpiproperty
dpi:Number  [read-write]

The output dpi of the dynamic map service layer.

The default value is 96.

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

Implementation
    public function get dpi():Number
    public function set dpi(value:Number):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
imageTransparencyproperty 
imageTransparency:Boolean  [read-write]

Whether or not the background of dynamic image is transparent.

The default value is true.

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

Implementation
    public function get imageTransparency():Boolean
    public function set imageTransparency(value:Boolean):void
jobIdproperty 
jobId:String  [read-write]

The jobId returned from JobInfo.

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

Implementation
    public function get jobId():String
    public function set jobId(value:String):void
parameterNameproperty 
parameterName:String  [read-write]

The name of the result parameter as defined in ArcGIS Services Directory.

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

Implementation
    public function get parameterName():String
    public function set parameterName(value:String):void
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
tokenproperty 
public var token:String

Token for accessing a secure ArcGIS.

urlproperty 
url:String  [read-write]

URL endpoint of a service. An example URL for a Geoprocessor task is http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Elevation/ESRI_Elevation_World/GPServer/Viewshed. However, in most cases you will not set this directly, but instead use Geoprocessor#getResultImageLayer.

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

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

See also

Constructor detail
GPResultImageLayer()constructor
public function GPResultImageLayer(url:String = null)

Creates a new GPResultImageLayer object.

Parameters
url:String (default = null) — ArcGIS Server REST API endpoint to the resource that receives the geoprocessing request.