Interface WMSLayerJson

A layer consuming a Web Map Service (WMS). The WMS specification is an international specification for serving and consuming dynamic maps on the web. For additional information on publishing WMS services, please see the ArcGIS Server help.

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

interface WMSLayerJson {
    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;
    customLayerParameters?: Record<string, unknown>;
    customParameters?: Record<string, unknown>;
    effect?: EffectJson;
    extent?: number[][];
    featureInfoFormat?: "text/html" | "text/plain";
    featureInfoUrl?: string;
    format?: string;
    id?: string;
    isReference?: boolean;
    itemId?: string;
    layers?: WMSSublayerJson[];
    layerType: "WMS";
    legendUrl?: string;
    listMode?: LayerListMode;
    mapUrl?: string;
    maxHeight?: number;
    maxScale?: number;
    maxWidth?: number;
    minScale?: number;
    opacity?: number;
    refreshInterval?: number;
    showLegend?: boolean;
    spatialReferences?: number[];
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    version?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
    visibleLayers?: string[];
}

Hierarchy (view full)

Properties

blendMode? copyright? customLayerParameters? customParameters? effect? extent? featureInfoFormat? featureInfoUrl? format? id? isReference? itemId? layers? layerType legendUrl? listMode? mapUrl? maxHeight? maxScale? maxWidth? minScale? opacity? refreshInterval? showLegend? spatialReferences? title? type? url? version? visibility? visibilityTimeExtent? visibleLayers?

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

A string containing copyright and access information for a WMS layer. This is copied from the capabilities document exposed by the WMS service.

OptionalcustomLayerParameters

customLayerParameters?: Record<string, unknown>

A sequence of custom parameters to WMS layer requests. These parameters are applied to GetMap and GetFeatureInfo requests. The customLayerParameters property takes precedence if customParameters is also present.

OptionalcustomParameters

customParameters?: Record<string, unknown>

A sequence of custom parameters to all WMS requests. These parameters are applied to GetCapabilities, GetMap, and GetFeatureInfo requests. If used with the customLayerParameters property, customParameters will not take precedence.

Optionaleffect

effect?: EffectJson

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

Optionalextent

extent?: number[][]

The rectangular map extent that should be requested from the service.

OptionalfeatureInfoFormat

featureInfoFormat?: "text/html" | "text/plain"

Format of the Feature.

OptionalfeatureInfoUrl

featureInfoUrl?: string

URL of the Feature.

Optionalformat

format?: string

A string containing the image format to be requested from a WMS service.

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?: WMSSublayerJson[]

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

layerType

layerType

Type of the layer.

OptionallegendUrl

legendUrl?: string

URL to legend.

OptionallistMode

listMode?: LayerListMode

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

OptionalmapUrl

mapUrl?: string

The URL of the WMS map. You should also supply the url property, which is the URL of the WMS capabilities document.

OptionalmaxHeight

maxHeight?: number

A number defining the maximum height, in pixels, that should be requested from the service.

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.

OptionalmaxWidth

maxWidth?: number

A number defining the maximum width, in pixels, that should be requested from the service.

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.

OptionalspatialReferences

spatialReferences?: number[]

An array of numbers containing well-known IDs for spatial references supported by the service.

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.

Optionalversion

version?: string

A string containing the version number of the 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.

OptionalvisibleLayers

visibleLayers?: string[]

An array of layers that should appear visible. The array contains the names of the visible layers.

Settings

Member Visibility

On This Page

Properties