Interface TiledMapServiceLayerJson

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

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

interface TiledMapServiceLayerJson {
    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";
    customParameters?: Record<string, unknown>;
    displayLevels?: number[];
    effect?: EffectJson;
    exclusionAreas?: {
        geometry?: ExtentJson;
        maxScale?: number;
        maxZoom?: number;
        minScale?: number;
        minZoom?: number;
    };
    id?: string;
    isReference?: boolean;
    itemId?: string;
    layers?: SublayerJson[];
    layerType: "ArcGISTiledMapServiceLayer";
    listMode?: LayerListMode;
    maxScale?: number;
    minScale?: number;
    opacity?: number;
    path?: string;
    refreshInterval?: number;
    showLegend?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
}

Hierarchy (view full)

Properties

blendMode? customParameters? displayLevels? effect? exclusionAreas? id? isReference? itemId? layers? layerType listMode? maxScale? minScale? opacity? path? refreshInterval? showLegend? title? type? url? visibility? visibilityTimeExtent?

Properties

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.

OptionalcustomParameters

customParameters?: Record<string, unknown>

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

OptionaldisplayLevels

displayLevels?: number[]

NOTE: Applicable if used as a baseMapLayer. Integer value(s) indicating the display levels of the basemap layer. Only applicable for TiledMapService layers. All tiled map service layers should share the same tiling scheme. This property cannot be set via the Map Viewer UI.

Optionaleffect

effect?: EffectJson

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

OptionalexclusionAreas

exclusionAreas?: {
    geometry?: ExtentJson;
    maxScale?: number;
    maxZoom?: number;
    minScale?: number;
    minZoom?: number;
}

Exclusion areas define extent areas where no data will be fetched for a layer. NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions. See https://developers.arcgis.com/web-map-specification/objects/exclusionArea/.

Type declaration

  • Optionalgeometry?: ExtentJson

    The geometry defining the area where no data will be fetched. Only extent is supported.

  • OptionalmaxScale?: number

    The zoom level where the exclusion ends.

  • OptionalmaxZoom?: number

    The zoom level where the exclusion ends.

  • OptionalminScale?: number

    The zoom level where the exclusion starts.

  • OptionalminZoom?: number

    The zoom level where the exclusion starts.

Optionalid

id?: string

A unique identifying string for the layer.

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.

Optionallayers

layers?: SublayerJson[]

An array of layer objects defining the styling, geometry, and attribute information for the features.

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.

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.

Optionalpath

path?: string

The path to the supporting offline layer. Mobile only. Only valid in MMAP JSON.

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.

OptionalshowLegend

showLegend?: boolean

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

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

URL to the ArcGIS Server tiled Map Service.

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