Image Service Layer (ArcGISImageServiceLayer)

An image service provides access to raster data through a web service. Multiple rasters can be served as one image service through mosaic dataset technology, dynamically processed and mosaicked on the fly. An image service supports accessing both the mosaicked image and its catalog, as well as individual rasters in the catalog. Also, image services can be cached (tiled) or uncached (dynamic). This object specifically details properties within uncached image services.

Referenced by: baseMapLayer, operationalLayers

Properties

Property Details
bandIds An array of bandIds that are visible for a multispectral dataset. It can specify bands to export or rearrange band order(from image service).
compressionQuality Controls how much loss the image will be subjected to by the compression algorithm (from image service).
compressionTolerance Controls the tolerance of the lerc compression algorithm. The tolerance defines the maximum possible error of pixel values in the compressed image.
customParameters A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types.
disablePopup Boolean property indicating whether to ignore popups defined by the service item.
format String value representing image format.
Valid values: bmp, gif, jpg, jpgpng, lerc, png, png24, png32, png8, tiff
id A unique identifying string for the layer.
interpolation The algorithm used for interpolation.
Valid values:
  • RSP_BilinearInterpolation
  • RSP_CubicConvolution
  • RSP_Majority
  • RSP_NearestNeighbor
isReference This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).
itemId Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition An object that defines the attribute schema and drawing information for a layer drawn using client-side graphics.
See layerDefinition properties table.
layerType String indicating the layer type.
Valid value of this property ArcGISImageServiceLayer
listMode To show or hide layers in the layer list
Valid values:
  • hide
  • show
maxScale A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
minScale A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
mosaicRule Specifies the mosaic rule when defining how individual images should be mosaicked.
noData The pixel value that represents no information.
noDataInterpretation A string value of interpretation of noData setting. Default is esriNoDataMatchAny when noData is a number, and esriNoDataMatchAll when noData is an array.
Valid values:
  • esriNoDataMatchAll
  • esriNoDataMatchAny
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
pixelType Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.
Valid values: C128, C64, F32, F64, S16, S32, S8, U1, U16, U2, U32, U4, U8, UNKNOWN
popupInfo A popupInfo object defining the content of popup windows when you click on the image.
refreshInterval Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
renderingRule Specifies the rendering rule for how the requested image should be rendered.
showLegend Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend control.
title A user-friendly string title for the layer that can be used in a table of contents.
url The URL to the layer.
visibility Boolean property determining whether the layer is initially visible in the web map.

layerDefinition properties

Property Details
definitionExpression SQL-based definition expression string that narrows the data to be displayed in the layer.
drawingInfo.renderer The renderer object contains the drawing information for the operationalLayer.
drawingInfo.transparency Number value ranging between 0 (no transparency) to 100 (completely transparent).

Image Service with renderingRule Example

{
  "id": "CharlotteLAS_88",
  "layerType": "ArcGISImageServiceLayer",
  "url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer",
  "visibility": true,
  "format": "jpgpng",
  "compressionQuality": 95,
  "opacity": 1,
  "title": "CharlotteLAS",
  "renderingRule": {
    "rasterFunction": "Stretch",
    "rasterFunctionArguments": {
      "StretchType": 5,
      "DRA": false,
      "Gamma": [
        1
      ],
      "UseGamma": true
    },
    "outputPixelType": "U8"
  },
  "mosaicRule": {
    "mosaicMethod": "esriMosaicSeamline",
    "mosaicOperation": "MT_BLEND"
  }
}

Image Service with renderer Example

{
  "id": "f297e8f3d9ad4a12997b814d767d4b23",
  "title": "Elevation\\mn30_grd_m2_sml",
  "visibility": false,
  "opacity": 1,
  "url": "https://kukui.esri.com:6443/arcgis/rest/services/Elevation/mn30_grd_m2_sml/ImageServer",
  "layerType": "ArcGISImageServiceLayer",
  "compressionQuality": 75,
  "layerDefinition": {
    "drawingInfo": {
      "renderer": {
        "type": "rasterStretch",
        "stretchType": "percentClip",
        "dra": false,
        "gamma": [
          1
        ],
        "useGamma": false,
        "minPercent": 0.5,
        "maxPercent": 0.5,
        "colorRamp": {
          "type": "multipart",
          "colorRamps": [
            {
              "type": "algorithmic",
              "algorithm": "esriCIELabAlgorithm",
              "fromColor": [
                138,
                29,
                94,
                255
              ],
              "toColor": [
                145,
                190,
                253,
                255
              ]
            },
            {
              "type": "algorithmic",
              "algorithm": "esriHSVAlgorithm",
              "fromColor": [
                255,
                255,
                115,
                255
              ],
              "toColor": [
                230,
                0,
                0,
                255
              ]
            }
          ]
        }
      }
    }
  },
  "mosaicRule": {
    "mosaicMethod": "esriMosaicCenter",
    "ascending": true,
    "mosaicOperation": "MT_FIRST"
  },
  "interpolation": "RSP_BilinearInterpolation"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.