Interface ImageServiceLayerJson

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 mosaiced 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.

See https://developers.arcgis.com/web-map-specification/objects/imageServiceLayer/ https://developers.arcgis.com/web-scene-specification/objects/imageServiceLayer/.

interface ImageServiceLayerJson {
    bandIds?: number[];
    blendMode?:
        | "invert"
        | "normal"
        | "lighter"
        | "multiply"
        | "color"
        | "average"
        | "color-burn"
        | "color-dodge"
        | "darken"
        | "destination-atop"
        | "destination-in"
        | "destination-out"
        | "destination-over"
        | "difference"
        | "exclusion"
        | "hard-light"
        | "hue"
        | "lighten"
        | "luminosity"
        | "minus"
        | "overlay"
        | "plus"
        | "reflect"
        | "saturation"
        | "screen"
        | "soft-light"
        | "source-atop"
        | "source-in"
        | "source-out"
        | "vivid-light"
        | "xor";
    compressionQuality?: number;
    copyright?: string;
    customParameters?: Record<string, unknown>;
    definitionEditor?: DefinitionEditorJson;
    effect?: EffectJson;
    format?:
        | "png"
        | "png8"
        | "png24"
        | "png32"
        | "jpg"
        | "tiff"
        | "lerc"
        | "jpgpng";
    id?: string;
    interpolation?:
        | "RSP_BilinearInterpolation"
        | "RSP_CubicConvolution"
        | "RSP_Majority"
        | "RSP_NearestNeighbor";
    isReference?: boolean;
    itemId?: string;
    layerDefinition?: LayerDefinitionJson;
    layerType: "ArcGISImageServiceLayer";
    listMode?: LayerListMode;
    maxScale?: number;
    minScale?: number;
    mosaicRule?: MosaicRuleJson;
    noDataInterpretation?: "esriNoDataMatchAll" | "esriNoDataMatchAny";
    opacity?: number;
    pixelType?: string;
    popupInfo?: PopupInfoJson;
    refreshInterval?: number;
    renderingRule?: RenderingRuleJson;
    showLegend?: boolean;
    timeAnimation?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
}

Hierarchy (view full)

Properties

bandIds? blendMode? compressionQuality? copyright? customParameters? definitionEditor? effect? format? id? interpolation? isReference? itemId? layerDefinition? layerType listMode? maxScale? minScale? mosaicRule? noDataInterpretation? opacity? pixelType? popupInfo? refreshInterval? renderingRule? showLegend? timeAnimation? title? type? url? visibility? visibilityTimeExtent?

Properties

OptionalbandIds

bandIds?: number[]

An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service).

OptionalblendMode

blendMode?:
    | "invert"
    | "normal"
    | "lighter"
    | "multiply"
    | "color"
    | "average"
    | "color-burn"
    | "color-dodge"
    | "darken"
    | "destination-atop"
    | "destination-in"
    | "destination-out"
    | "destination-over"
    | "difference"
    | "exclusion"
    | "hard-light"
    | "hue"
    | "lighten"
    | "luminosity"
    | "minus"
    | "overlay"
    | "plus"
    | "reflect"
    | "saturation"
    | "screen"
    | "soft-light"
    | "source-atop"
    | "source-in"
    | "source-out"
    | "vivid-light"
    | "xor"

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

OptionalcompressionQuality

compressionQuality?: number

Controls how much loss the image will be subjected to by the compression algorithm (from image service).

Optionalcopyright

copyright?: string

The attribution information for the layer. (not in the documentation).

OptionalcustomParameters

customParameters?: Record<string, unknown>

A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types.

OptionaldefinitionEditor

definitionEditor?: DefinitionEditorJson

Stores interactive filters.

Optionaleffect

effect?: EffectJson

Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.

Optionalformat

format?:
    | "png"
    | "png8"
    | "png24"
    | "png32"
    | "jpg"
    | "tiff"
    | "lerc"
    | "jpgpng"

The output image type.

Optionalid

id?: string

A unique identifying string for the layer.

Optionalinterpolation

interpolation?:
    | "RSP_BilinearInterpolation"
    | "RSP_CubicConvolution"
    | "RSP_Majority"
    | "RSP_NearestNeighbor"

The algorithm used for interpolation.

OptionalisReference

isReference?: boolean

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).

OptionalitemId

itemId?: string

Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.

OptionallayerDefinition

layerDefinition?: LayerDefinitionJson

A layerDefinition object defining the attribute schema and drawing information for the layer.

layerType

layerType

The type of layer.

OptionallistMode

listMode?: LayerListMode

Indicates how the layer should display in the table of contents. The known values are listed below. See support/esri!ListMode.

OptionalmaxScale

maxScale?: number

A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.

OptionalminScale

minScale?: number

A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.

OptionalmosaicRule

mosaicRule?: MosaicRuleJson

Specifies the mosaic rule when defining how individual images should be mosaiced.

OptionalnoDataInterpretation

noDataInterpretation?: "esriNoDataMatchAll" | "esriNoDataMatchAny"

A string value of interpretation of noData setting. Default is 'esriNoDataMatchAny' when noData is a number, and 'esriNoDataMatchAll' when noData is an array.

Optionalopacity

opacity?: number

The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.

OptionalpixelType

pixelType?: string

Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. See OutputPixelType.

OptionalpopupInfo

popupInfo?: PopupInfoJson

A PopupInfo object defining the content of pop-up windows when you click or query a feature.

OptionalrefreshInterval

refreshInterval?: number

When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm.

OptionalrenderingRule

renderingRule?: RenderingRuleJson

Specifies the rule for how the requested image should be rendered.

OptionalshowLegend

showLegend?: boolean

Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.

OptionaltimeAnimation

timeAnimation?: boolean

This property is applicable to layers that support time. If 'true', timeAnimation is enabled.

Optionaltitle

title?: string

A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.

Optionaltype

type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType

(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.

Optionalurl

url?: string

The URL to the layer.

Optionalvisibility

visibility?: boolean

Determines whether the layer is initially visible in the web map.

OptionalvisibilityTimeExtent

visibilityTimeExtent?: [number, number]

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.

Settings

Member Visibility

On This Page

Properties