Interface WebTileLayerJson

A tile layer is a derived from a set of web-accessible tiles which reside on a server. The tiles are accessed by a direct URL request from the web browser. Because the tiles in a tile layer are not available as a service, they must be in a specific format for a web app such as the ArcGIS.com map viewer to display the layer on a map.

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

interface WebTileLayerJson {
    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";
    copyright?: string;
    effect?: EffectJson;
    fullExtent?: ExtentJson;
    id?: string;
    isReference?: boolean;
    itemId?: string;
    layerType: "WebTiledLayer";
    listMode?: LayerListMode;
    maxScale?: number;
    minScale?: number;
    opacity?: number;
    refreshInterval?: number;
    showLegend?: boolean;
    subDomains?: string[];
    templateUrl?: string;
    tileInfo?: TileInfoJson;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
    wmtsInfo?: WMTSInfoJson;
}

Hierarchy (view full)

Properties

blendMode? copyright? effect? fullExtent? id? isReference? itemId? layerType listMode? maxScale? minScale? opacity? refreshInterval? showLegend? subDomains? templateUrl? tileInfo? title? type? visibility? visibilityTimeExtent? wmtsInfo?

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.

Optionalcopyright

copyright?: string

Attribution to the Web Tile Layer provider. It is displayed in the attribution on the web map. Input required by the user when the layer is added to the web map.

Optionaleffect

effect?: EffectJson

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

OptionalfullExtent

fullExtent?: ExtentJson

An extent object representing the full extent envelope for the layer.

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.

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.

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.

OptionalsubDomains

subDomains?: string[]

If sub-domains are detected, they must be specified. The map viewer detects if the Web Tile Layer has sub-domains by parsing the templateURL value for {subDomain}.

OptionaltemplateUrl

templateUrl?: string

URL to the Web Tile Layer. Input required by the user when the layer is added to the web scene. The template URL contains a parameterized URL. The URL can contain the following template parameters: {level}, {col}, {row}, and {subDomain}.

OptionaltileInfo

tileInfo?: TileInfoJson

An extent object representing the full extent envelope for the layer.

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.

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.

OptionalwmtsInfo

wmtsInfo?: WMTSInfoJson

An object representing information about this layer if it is a WMTS layer.

Settings

Member Visibility

On This Page

Properties