ImageParameters

require(["esri/layers/support/ImageParameters"], function(ImageParameters) { /* code goes here */ });
Class: esri/layers/support/ImageParameters
Inheritance: ImageParameters Accessor
Since: ArcGIS API for JavaScript 4.0

Represents the image parameter options used when calling Geoprocessor.getResultImage() and Geoprocessor.getResultImageLayer().

See also:

Constructors

new ImageParameters(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Number

Dots per inch setting for an esri/layersMapImageLayer.

more details
more detailsImageParameters
Extent

Extent of map to be exported.

more details
more detailsImageParameters
String

Map image format.

more details
more detailsImageParameters
Number

Requested image height in pixels.

more details
more detailsImageParameters
SpatialReference

Spatial reference of exported map.

more details
more detailsImageParameters
String[]

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

more details
more detailsImageParameters
Number[]

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

more details
more detailsImageParameters
String

The option for displaying or hiding the layer.

more details
more detailsImageParameters
Boolean

Indicates whether or not the background of the dynamic image is transparent.

more details
more detailsImageParameters
Number

Requested image width in pixels.

more details
more detailsImageParameters

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

Dots per inch setting for an esri/layersMapImageLayer.

Default Value: 96

extentExtent

Extent of map to be exported.

formatString

Map image format.

Known Values: png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svg

Default Value: png8
Example:
let imageParams = new ImageParameters();
imageParams.format = "jpg";

heightNumber

Requested image height in pixels.

imageSpatialReferenceSpatialReference

Spatial reference of exported map.

layerDefinitionsString[]

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
});

layerIdsNumber[]

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";

layerOptionString

The option for displaying or hiding the layer.

Known Values: show | hide | include | exclude

Example:
let imageParams = new ImageParameters();
imageParams.layerOption = "show";

transparentBoolean

Indicates whether or not the background of the dynamic image is transparent.

Default Value: true

widthNumber

Requested image width in pixels.

Method Overview

NameReturn TypeSummaryClass
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsImageParameters

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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.