Packagecom.esri.ags.layers
Classpublic class ImageParameters

Represents the image parameter options used when calling ArcGISDynamicMapServiceLayer.exportMapImage, Geoprocessor.getResultImage, and Geoprocessor.getResultImageLayer.

See also

ArcGISDynamicMapServiceLayer.exportMapImage()
com.esri.ags.tasks.Geoprocessor.getResultImage()
com.esri.ags.tasks.Geoprocessor.getResultImageLayer()


Public Properties
 PropertyDefined by
  dpi : Number
Dots per inch setting for an ArcGISDynamicMapServiceLayer.
ImageParameters
  extent : Extent
Extent of map to be exported.
ImageParameters
  format : String
Map image format.
ImageParameters
  height : Number
Requested image height in pixels.
ImageParameters
  imageSpatialReference : SpatialReference
Spatial reference of exported map.
ImageParameters
  layerDefinitions : Array
Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image.
ImageParameters
  layerIds : Array
A list of layer IDs, which represents which layers to include in the exported map.
ImageParameters
  layerOption : String
The option for displaying or hiding the layer.
ImageParameters
  transparent : Boolean = true
Whether or not the background of dynamic image is transparent.
ImageParameters
  width : Number
Requested image width in pixels.
ImageParameters
Public Constants
 ConstantDefined by
  LAYER_OPTION_EXCLUDE : String = "exclude"
[static] Shows all layers visible by default except the specified layer IDs.
ImageParameters
  LAYER_OPTION_HIDE : String = "hide"
[static] Shows all layers except the specified layer IDs.
ImageParameters
  LAYER_OPTION_INCLUDE : String = "include"
[static] Shows specified layer IDs in addition to layers visible by default.
ImageParameters
  LAYER_OPTION_SHOW : String = "show"
[static] Shows only the specified layer IDs.
ImageParameters
Property detail
dpiproperty
public var dpi:Number

Dots per inch setting for an ArcGISDynamicMapServiceLayer.

extentproperty 
public var extent:Extent

Extent of map to be exported.

formatproperty 
public var format:String

Map image format. Can be set to any of the following image types: png8 | png24 | png32 | jpg | pdf | bmp | gif | svg.

heightproperty 
public var height:Number

Requested image height in pixels.

imageSpatialReferenceproperty 
public var imageSpatialReference:SpatialReference

Spatial reference of exported map.

layerDefinitionsproperty 
public var layerDefinitions:Array

Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image.

layerIdsproperty 
public var layerIds:Array

A list of layer IDs, which represents which layers to include in the exported map.

layerOptionproperty 
public var layerOption:String

The option for displaying or hiding the layer.

transparentproperty 
public var transparent:Boolean = true

Whether or not the background of dynamic image is transparent.

widthproperty 
public var width:Number

Requested image width in pixels.

Constant detail
LAYER_OPTION_EXCLUDEconstant
public static const LAYER_OPTION_EXCLUDE:String = "exclude"

Shows all layers visible by default except the specified layer IDs.

LAYER_OPTION_HIDEconstant 
public static const LAYER_OPTION_HIDE:String = "hide"

Shows all layers except the specified layer IDs.

LAYER_OPTION_INCLUDEconstant 
public static const LAYER_OPTION_INCLUDE:String = "include"

Shows specified layer IDs in addition to layers visible by default.

LAYER_OPTION_SHOWconstant 
public static const LAYER_OPTION_SHOW:String = "show"

Shows only the specified layer IDs.