Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ImageParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/ImageParameters"], function(ImageParameters) { /* code goes here */ });
Description
(Added at v1.0)
Represents the image parameter options used when calling ArcGISDynamicMapServiceLayer.exportMapImage, Geoprocessor.getResultImage, and Geoprocessor.getResultImageLayer.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ImageParameters() | Creates a new ImageParameters object. |
Constants
| Name | 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. |
Properties
| Name | Type | Summary |
|---|---|---|
| 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. |
| 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. |
| layerOption | String | The option for displaying or hiding the layer. |
| layerTimeOptions | LayerTimeOptions[] | Array of LayerTimeOptions objects that allow you to override how a layer is exported in reference to the map's time extent. |
| timeExtent | TimeExtent | The time extent for the map image. |
| transparent | Boolean | Whether or not background of dynamic image is transparent. |
| width | Number | Requested image width in pixels. |
Constructor Details
Creates a new ImageParameters object. The constructor takes no parameters.
Sample:
require([
"esri/layers/ImageParameters", ...
], function(ImageParameters, ... ) {
var imageParameters = new ImageParameters();
...
});
Property Details
<Extent
ExtentExtent of map to be exported.
<String
StringMap image format.
Known values:
png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svgDefault value:
png8Sample:
imageParameters.format = "jpeg";
<Number
NumberRequested image height in pixels.
<SpatialReference
SpatialReferenceSpatial reference of exported map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
<String[]
String[]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.
Sample:
var layerDefs = []; layerDefs[5] = "STATE_NAME='Kansas'"; layerDefs[4] = "STATE_NAME='Kansas' and POP2007>25000"; layerDefs[3] = "STATE_NAME='Kansas' and POP2007>25000"; imageParameters.layerDefinitions = layerDefs;
<Number[]
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 visibility is handled.
Sample:
require([
"esri/layers/ImageParameters", ...
], function(ImageParameters, ... ) {
var imageParameters = new ImageParameters();
imageParameters.layerIds = [3,4,5];
imageParameters.layerOption = ImageParameters.LAYER_OPTION_SHOW;
...
});
<String
StringThe option for displaying or hiding the layer. See the Constants table for valid values.
Sample:
require([
"esri/layers/ImageParameters", ...
], function(ImageParameters, ... ) {
var imageParameters = new ImageParameters();
imageParameters.layerOption = ImageParameters.LAYER_OPTION_SHOW;
...
});
<LayerTimeOptions[]
LayerTimeOptions[]Array of LayerTimeOptions objects that allow you to override how a layer is exported in reference to the map's time extent. There is one object per sub-layer. (Added at v2.0)
Sample:
In the following example, array indices 2 and 5 are valid sub-layer IDs.
require([
"esri/layers/ImageParameters", "esri/layers/LayerTimeOptions", "esri/layers/TimeInfo", ...
], function(ImageParameters, LayerTimeOptions, TimeInfo, ... ) {
var imageParameters = new ImageParameters();
var timeOption1 = new LayerTimeOptions();
timeOption1.timeOffset = 4;
timeOption1.timeOffsetUnits = TimeInfo.UNIT_YEARS;
var options = [];
options[2]= timeOption1;
options[5] = timeOption2;
imageParameters.layerTimeOptions = options;
...
});
<TimeExtent
TimeExtentThe time extent for the map image. (Added at v2.0)
<Boolean
BooleanWhether or not background of dynamic image is transparent.
Known values:
true | falseDefault value:
true<Number
NumberRequested image width in pixels.