Class: ImageParametersE-mail This Topic Printable Version Give Us Feedback

Description

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

Class hierarchy

esri.layers.ImageParameters

Constructor

Constructor Description
esri.layers.ImageParameters() Creates a new ImageParameters object. The constructor takes no parameters.

Properties

Property Type Description
bbox Extent Extent of map to be exported.
dpi Number Dots per inch setting for an ArcGISDynamicMapServiceLayer.
format String Map image format.
height Number Requested image height in pixels.
imageSpatialReference SpatialReference Spatial reference of exported map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
layerDefinitions String[] Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image.
layerIds Number[] A list of layer ID's, that represent which layers to include in the exported map.Use in combination with layerOption to specify how layer visiblity is handled.
layerOption String The option for displaying or hiding the layer. See the Constants table for valid values.
transparent Boolean Whether or not background of dynamic image is transparent.
width Number Requested image width in pixels.

Constants

Constant Description
LAYER_OPTION_EXCLUDE Shows all layers visible by default except the specified layer ID's.
LAYER_OPTION_HIDE Shows all layers except the specified layer ID's.
LAYER_OPTION_INCLUDE Shows specified layer ID's in addition to layers visible by default.
LAYER_OPTION_SHOW Shows only the specified layer ID's.
Constructor Detail

esri.layers.ImageParameters()

Creates a new ImageParameters object. The constructor takes no parameters.
Properties Detail

<Extent> bbox

Extent of map to be exported.

<Number> dpi

Dots per inch setting for an ArcGISDynamicMapServiceLayer.
Default value: 96

<String> format

Map image format.
Known values: png | png8 | png24 | jpg | pdf | bmp | gif | svg
Default value: png8

<Number> height

Requested image height in pixels.

<SpatialReference> imageSpatialReference

Spatial reference of exported map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.

<String[]> layerDefinitions

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

<Number[]> layerIds

A list of layer ID's, that represent which layers to include in the exported map.Use in combination with layerOption to specify how layer visiblity is handled.
Code snippets:
imageParameters.layerIds = [3,4,5];
imageParameters.layerOption = esri.layers.ImageParameters.LAYER_OPTION_SHOW;

<String> layerOption

The option for displaying or hiding the layer. See the Constants table for valid values.

<Boolean> transparent

Whether or not background of dynamic image is transparent.
Known values: true | false
Default value: true

<Number> width

Requested image width in pixels.