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: ImageServiceParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/ImageServiceParameters"], function(ImageServiceParameters) { /* code goes here */ });
Description
(Added at v1.2)
Represents the image service parameter options used when calling ArcGISImageServiceLayer.exportMapImage. (As of v1.2)Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ImageServiceParameters() | Creates a new ImageServiceParameters object. |
Constants
| Name | Description |
|---|---|
INTERPOLATION_BILINEAR | Resamples pixel by bilinear interpolation. |
INTERPOLATION_CUBICCONVOLUTION | Resamples pixel by cubic convolution. |
INTERPOLATION_MAJORITY | Resamples pixel by majority value. |
INTERPOLATION_NEARESTNEIGHBOR | Resamples pixel by nearest neighbor. |
Properties
| Name | Type | Summary |
|---|---|---|
| bandIds | Number[] | Array of current band selections. |
| compressionQuality | Number | Current compression quality value. |
| extent | Extent | Extent of the exported image. |
| format | String | Map image format. |
| height | Number | Requested image height in pixels. |
| interpolation | String | Current interpolation method. |
| mosaicRule | MosaicRule | Specifies the mosaic rule when defining how individual images should be mosaicked. |
| noData | Number | The pixel value that represents no information. |
| renderingRule | RasterFunction | Specifies the rendering rule for how the requested image should be rendered. |
| timeExtent | TimeExtent | Define the time extent for the image. |
| width | Number | Requested image width in pixels. |
Constructor Details
Creates a new ImageServiceParameters object. The constructor takes no parameters.
Sample:
require([
"esri/layers/ImageServiceParameters", ...
], function(ImageServiceParameters, ... ) {
var params = new ImageServiceParameters();
...
});
Property Details
<Number
NumberCurrent compression quality value. The compression quality controls how much loss the image will be subjected to. Only valid with JPG image types.
<Extent
ExtentExtent of the exported image.
<String
StringMap image format. If no format is specified the format is set to the server default which is jpgpng
Known values:
png8 | png24 | jpg | bmp | gif | jpgpngSample:
require([
"esri/layers/ImageServiceParameters", ...
], function(ImageServiceParameters, ... ) {
var params = new ImageServiceParameters();
params.format = "jpgpng";
...
});
<Number
NumberRequested image height in pixels.
<String
StringCurrent interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.
<MosaicRule
MosaicRuleSpecifies the mosaic rule when defining how individual images should be mosaicked.
Sample:
require([
"esri/layers/ImageServiceParameters", "esri/layers/MosaicRule", ...
], function(ImageServiceParameters, MosaicRule, ... ) {
var params = new ImageServiceParameters();
var mr = new MosaicRule();
mr.method = MosaicRule.METHOD_LOCKRASTER;
mr.lockRasterIds = [32,454,14];
params.mosaicRule = mr;
...
});
<Number
NumberThe pixel value that represents no information.
Sample:
require([
"esri/layers/ImageServiceParameters", ...
], function(ImageServiceParameters, ... ) {
var params = new ImageServiceParameters();
params.noData = 0;
...
});
<RasterFunction
RasterFunctionSpecifies the rendering rule for how the requested image should be rendered. View the Raster Functions help topic in the REST help for more details.
Sample:
require([
"esri/layers/ImageServiceParameters", "esri/layers/RasterFunction", ...
], function(ImageServiceParameters, RasterFunction, ... ) {
var params = new ImageServiceParameters();
var rasterFunction = new RasterFunction();
rasterFunction.functionName = "Hillshade";
rasterFunction.arguments = {
"Azimuth":215.0,
"Altitude":75.0,
"ZFactor":0.3
};
rasterFunction.variableName = "DEM";
params.renderingRule = rasterFunction;
...
});
<TimeExtent
TimeExtentDefine the time extent for the image.
<Number
NumberRequested image width in pixels.