Tiled Image Service Layer (ArcGISTiledImageServiceLayer)

An ArcGIS Tiled Image Service layer displays map content from an ArcGIS Server Image service that has been cached (tiled).

Referenced by: baseMapLayer, operationalLayers

Properties

Property Details
bandIds[] The band selection for a multispectral dataset
blendMode Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.
Valid values: average, color, color-burn, color-dodge, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor
customParameters A sequence of custom parameters appended to the URL of all requests related to a layer.
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
effect Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
id A unique identifying string for the layer.
interpolation String indicating the interpolation type.
Valid values:
  • RSP_BilinearInterpolation
  • RSP_CubicConvolution
  • RSP_Majority
  • RSP_NearestNeighbor
isReference 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 drawing information for image service based layers.
See layerDefinition properties table.
layerType String indicating the layer type.
Valid value of this property ArcGISTiledImageServiceLayer
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.
multidimensionalDefinition[] An array of objects representing a slice from multidimensional data. The dimensional definitions in this array are used to filter display data based on slices in one or more dimensions.
multidimensionalSubset An object representing a subset from multidimensional data. This includes subsets of both variables and dimensions. When the multidimensionalSubset is defined on a tiled image service layer, the layer's multidimensionalDefinition must be within the defined multidimensionalSubset, otherwise nothing will be displayed.
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo A popupInfo object defining the content of popup windows when you click or query a feature.
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 Boolean value indicating whether to display the layer in the legend. Default value is true.
timeAnimation This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title A user-friendly string title for the layer that can be used in a table of contents.
url URL to the ArcGIS Server Image Service.
visibility Boolean property determining whether the layer is initially visible in the web map.
visibilityTimeExtent Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.

layerDefinition properties

Property Details
activePresetRendererName The name of the active preset renderer, if the image service layer's current renderer is from preset renderers.
drawingInfo Contains the drawing information.
presetRenderers[] An array of preset renderers for image service layers, each contains associated information of multidimensional variable or raster function template.

operationalLayer Example

{
  "id": "Toronto_4412",
  "blendMode": "destination-in",
  "layerType": "ArcGISTiledImageServiceLayer",
  "url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Toronto/ImageServer",
  "visibility": true,
  "opacity": 1,
  "title": "Toronto",
  "itemId": "b81671067dec4bd4b569f09d9884d70f",
  "minScale": 611770,
  "maxScale": 6059
}

Example

{
  "layerType": "ArcGISTiledImageServiceLayer",
  "url": "https://your-multidimensional-tiled-service",
  "visibility": true,
  "title": "HYCOM",
  "id": "HYCOM_layer8818",
  "multidimensionalDefinition": [
    {
      "variableName": "salinity",
      "dimensionName": "StdTime",
      "values": [
        1356998400000
      ],
      "isSlice": true
    },
    {
      "variableName": "salinity",
      "dimensionName": "StdZ",
      "values": [
        -500
      ],
      "isSlice": true
    }
  ],
  "multidimensionalSubset": {
    "areaOfInterest": {
      "xmin": -171,
      "xmax": -126,
      "ymin": 17,
      "ymax": 56,
      "spatialReference": {
        "wkid": 4326
      }
    },
    "subsetDefinitions": [
      {
        "variableName": "salinity",
        "dimensionName": "StdTime",
        "values": [
          1356998400000,
          1388448000000
        ],
        "isSlice": false
      },
      {
        "variableName": "salinity",
        "dimensionName": "StdZ",
        "values": [
          -1000,
          0
        ],
        "isSlice": false
      },
      {
        "variableName": "water_temp",
        "dimensionName": "StdTime",
        "values": [
          1356998400000,
          1388448000000
        ],
        "isSlice": false
      },
      {
        "variableName": "water_temp",
        "dimensionName": "StdZ",
        "values": [
          -1000,
          0
        ],
        "isSlice": false
      }
    ]
  }
}

Example

{
  "layerType": "ArcGISTiledImageServiceLayer",
  "url": "https://your-multidimensional-tiled-service",
  "visibility": true,
  "title": "HYCOM",
  "id": "HYCOM_layer8818",
  "layerDefinition": {
    "drawingInfo": {
      "renderer": {
        "colorRamp": {
          "type": "algorithmic",
          "algorithm": "esriHSVAlgorithm",
          "fromColor": [
            204,
            204,
            255,
            255
          ],
          "toColor": [
            0,
            0,
            224,
            255
          ]
        },
        "dra": false,
        "gamma": [
          1
        ],
        "max": 255,
        "min": 0,
        "statistics": [
          [
            1.46,
            41.92,
            34.54,
            1.53
          ]
        ],
        "useGamma": false,
        "stretchType": "minMax",
        "type": "rasterStretch"
      }
    },
    "activePresetRendererName": "Salinity",
    "presetRenderers": [
      {
        "name": "Salinity",
        "method": "variable",
        "value": "salinity",
        "bandIds": [
          0
        ],
        "renderer": {
          "colorRamp": {
            "type": "algorithmic",
            "algorithm": "esriHSVAlgorithm",
            "fromColor": [
              204,
              204,
              255,
              255
            ],
            "toColor": [
              0,
              0,
              224,
              255
            ]
          },
          "dra": false,
          "gamma": [
            1
          ],
          "max": 255,
          "min": 0,
          "statistics": [
            [
              1.46,
              41.92,
              34.54,
              1.53
            ]
          ],
          "useGamma": false,
          "stretchType": "minMax",
          "type": "rasterStretch"
        }
      },
      {
        "name": "Temperature",
        "method": "variable",
        "value": "water_temp",
        "bandIds": [
          0
        ],
        "renderer": {
          "colorRamp": {
            "type": "multipart",
            "colorRamps": [
              {
                "type": "algorithmic",
                "algorithm": "esriHSVAlgorithm",
                "fromColor": [
                  56,
                  168,
                  0,
                  255
                ],
                "toColor": [
                  255,
                  255,
                  0,
                  255
                ]
              },
              {
                "type": "algorithmic",
                "algorithm": "esriHSVAlgorithm",
                "fromColor": [
                  255,
                  255,
                  0,
                  255
                ],
                "toColor": [
                  255,
                  0,
                  0,
                  255
                ]
              }
            ]
          },
          "dra": false,
          "gamma": [
            1
          ],
          "max": 255,
          "min": 0,
          "statistics": [
            [
              -2.97,
              32.58,
              11.3,
              10.21
            ]
          ],
          "useGamma": false,
          "stretchType": "minMax",
          "type": "rasterStretch"
        }
      }
    ]
  },
  "multidimensionalDefinition": [
    {
      "variableName": "salinity",
      "dimensionName": "StdTime",
      "values": [
        1356998400000
      ],
      "isSlice": true
    },
    {
      "variableName": "salinity",
      "dimensionName": "StdZ",
      "values": [
        -500
      ],
      "isSlice": true
    }
  ]
}

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