Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ImageServiceParameters

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

NameSummary
new ImageServiceParameters()Creates a new ImageServiceParameters object.

Constants

NameDescription
INTERPOLATION_BILINEARResamples pixel by bilinear interpolation.
INTERPOLATION_CUBICCONVOLUTIONResamples pixel by cubic convolution.
INTERPOLATION_MAJORITYResamples pixel by majority value.
INTERPOLATION_NEARESTNEIGHBORResamples pixel by nearest neighbor.

Properties

NameTypeSummary
bandIdsNumber[]Array of current band selections.
compressionQualityNumberCurrent compression quality value.
extentExtentExtent of the exported image.
formatStringMap image format.
heightNumberRequested image height in pixels.
interpolationStringCurrent interpolation method.
mosaicRuleMosaicRuleSpecifies the mosaic rule when defining how individual images should be mosaicked.
noDataNumberThe pixel value that represents no information.
renderingRuleRasterFunctionSpecifies the rendering rule for how the requested image should be rendered.
timeExtentTimeExtentDefine the time extent for the image.
widthNumberRequested image width in pixels.
Constructor Details

new ImageServiceParameters()

Creates a new ImageServiceParameters object. The constructor takes no parameters.
Sample:
require([
  "esri/layers/ImageServiceParameters", ... 
], function(ImageServiceParameters, ... ) {
  var params = new ImageServiceParameters();
  ...
});
Property Details

<Number[]> bandIds

Array of current band selections.
Sample:

params.bandIds = [3,1,2];

<Number> compressionQuality

Current compression quality value. The compression quality controls how much loss the image will be subjected to. Only valid with JPG image types.

<Extent> extent

Extent of the exported image.

<String> format

Map 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 | jpgpng
Sample:
require([
  "esri/layers/ImageServiceParameters", ... 
], function(ImageServiceParameters, ... ) {
  var params = new ImageServiceParameters();
  params.format = "jpgpng";
  ...
});

<Number> height

Requested image height in pixels.

<String> interpolation

Current interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.

<MosaicRule> mosaicRule

Specifies 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> noData

The pixel value that represents no information.
Sample:
require([
  "esri/layers/ImageServiceParameters", ... 
], function(ImageServiceParameters, ... ) {
  var params = new ImageServiceParameters();
  params.noData = 0;
  ...
});

<RasterFunction> renderingRule

Specifies 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> timeExtent

Define the time extent for the image.

<Number> width

Requested image width in pixels.