Represents the image parameter options used when calling Geoprocessor.getResultImage() and Geoprocessor.getResultImageLayer().
Constructors
-
new ImageParameters(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
Number | Dots per inch setting for an esri/layersMapImageLayer. more details | more details | ImageParameters | |
Extent | Extent of map to be exported. more details | more details | ImageParameters | |
String | Map image format. more details | more details | ImageParameters | |
Number | Requested image height in pixels. more details | more details | ImageParameters | |
SpatialReference | Spatial reference of exported map. more details | more details | ImageParameters | |
String[] | Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. more details | more details | ImageParameters | |
Number[] | A list of layer IDs, that represent which layers to include in the exported map. more details | more details | ImageParameters | |
String | The option for displaying or hiding the layer. more details | more details | ImageParameters | |
Boolean | Indicates whether or not the background of the dynamic image is transparent. more details | more details | ImageParameters | |
Number | Requested image width in pixels. more details | more details | ImageParameters |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
dpi Number
-
Dots per inch setting for an esri/layersMapImageLayer.
- Default Value:96
-
extent Extent
-
Extent of map to be exported.
-
format String
-
Map image format.
Possible Values:"png"|"png8"|"png24"|"png32"|"jpg"|"pdf"|"bmp"|"gif"|"svg"
- Default Value:png8
Example:let imageParams = new ImageParameters(); imageParams.format = "jpg";
-
height Number
-
Requested image height in pixels.
-
imageSpatialReference SpatialReference
-
Spatial reference of exported map.
-
Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10 or later.
Example:let layerDefs = []; layerDefs[5] = "STATE_NAME='Kansas'"; layerDefs[4] = "STATE_NAME='Kansas' and POP2007>25000"; layerDefs[3] = "STATE_NAME='Kansas' and POP2007>25000"; let imageParams = new ImageParameters({ layerDefinitions: layerDefs });
-
A list of layer IDs, that represent which layers to include in the exported map. Use in combination with layerOption to specify how layer visibility is handled.
Example:let imageParams = new ImageParameters(); imageParams.layerIds = [3,4,5]; imageParams.layerOption = "show";
-
layerOption String
-
The option for displaying or hiding the layer.
Possible Values:"show"|"hide"|"include"|"exclude"
Example:let imageParams = new ImageParameters(); imageParams.layerOption = "show";
-
transparent Boolean
-
Indicates whether or not the background of the dynamic image is transparent.
- Default Value:true
-
width Number
-
Requested image width in pixels.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ImageParameters |
Method Details
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.