Class EsriWMSLayer

Hierarchy

Layer
BlendLayer
PortalLayer
ScaleRangeLayer
RefreshableLayer
- EsriWMSLayer

Index

Constructors

constructor

Constructors

constructor

new EsriWMSLayer(properties?): EsriWMSLayer
The WMSLayer is used to create layers based on OGC Web Map Services (WMS).

Read more...
Parameters
- Optional properties: WMSLayerProperties
Returns EsriWMSLayer
Inherited from Layer.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30828

Properties

allSublayers

allSublayers: Collection<EsriWMSSublayer>

A flattened collection of all WMSSublayers based on the sublayers property.

blendMode

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.

Default

normal

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode)

copyright

customLayerParameters

customLayerParameters: any

Use this to append different custom parameters to the WMS map requests.

customParameters

customParameters: any

Use this to append custom parameters to all WMS requests.

declaredClass

declaredClass: string

description

description: string

Description for the WMS layer.

destroyed

destroyed: boolean

`Readonly` dimensions

dimensions: (TimeDimension | ElevationDimension | GenericDimension)[]

An array of time, elevation and other dimensions for the root layer.

effect

effect: Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#effect)

featureInfoFormat

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

The MIME type that will be requested by popups.

`Readonly` featureInfoFormats

featureInfoFormats: string[]

This property lists all available MIME-types that can be used with the WMS service's GetFeatureInfo request.

featureInfoUrl

featureInfoUrl: string

The URL for the WMS GetFeatureInfo call.

fetchFeatureInfoFunction

fetchFeatureInfoFunction: FetchFeatureInfoFunction

Function to override the default popup behavior of WMSLayer.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchFeatureInfoFunction)

fullExtent

fullExtent: EsriExtent

The full extent of the layer.

fullExtents

fullExtents: EsriExtent[]

All bounding boxes defined for the layer.

id

id: string

The unique ID assigned to the layer.

imageFormat

imageFormat: string

The map image format (MIME type) to request.

imageMaxHeight

imageMaxHeight: number

Indicates the maximum height of the image exported by the service.

Default

2048

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxHeight)

imageMaxWidth

imageMaxWidth: number

Indicates the maximum width of the image exported by the service.

Default

2048

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxWidth)

imageTransparency

imageTransparency: boolean

Indicates whether the background of the image exported by the service is transparent.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageTransparency)

initialized

initialized: boolean

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#legendEnabled)

listMode

listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Default

"show"

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode)

`Readonly` loadError

loadError: Error

The Error object returned if an error occurred while loading.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError)

`Readonly` loadStatus

loadStatus: "loaded" | "loading" | "not-loaded" | "failed"

Represents the status of a load operation.

Default

not-loaded

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus)

`Readonly` loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

`Readonly` loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#loaded)

maxScale

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale)

minScale

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale)

opacity

opacity: number

The opacity of the layer.

Default

1

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity)

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval)

spatialReference

spatialReference: EsriSpatialReference

The spatial reference of the layer.

spatialReferences

spatialReferences: number[]

List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request.

sublayers

sublayers: Collection<EsriWMSSublayer>

A subset of the layer's WMSSublayers that will be displayed.

timeExtent

timeExtent: TimeExtent

The layer's time extent.

timeInfo

timeInfo: TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeInfo)

timeOffset

timeOffset: TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeOffset)

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

`Readonly` type

type: "wms"

url

url: string

The URL of the WMS service.

useViewTime

useViewTime: boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#useViewTime)

version

version: string

Version of the WMS specification to use.

visible

visible: boolean

Indicates if the layer is visible in the View.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible)

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Layer._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Layer._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriWMSLayer
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriWMSLayer
Inherited from Layer._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Layer.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

cancelLoad

cancelLoad(): void
Cancels a load() operation if it is already in progress.

Read more...

Returns void
Inherited from Layer.cancelLoad
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2220

createLayerView

createLayerView(view, options?): Promise<LayerView>
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

Read more...
Parameters
- view: any
- Optional options: LayerCreateLayerViewOptions
Returns Promise<LayerView>
Inherited from Layer.createLayerView
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14044

destroy

destroy(): void
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

Read more...

Returns void
Inherited from Layer.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14050

emit

emit(type, event?): boolean
Emits an event on the instance.

Read more...
Parameters
- type: string
- Optional event: any
Returns boolean
Inherited from Layer.emit
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2063

fetchAttributionData

fetchAttributionData(): Promise<any>
Fetches custom attribution data for the layer when it becomes available.

Read more...

Returns Promise<any>
Inherited from Layer.fetchAttributionData
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14056

fetchImage

fetchImage(extent, width, height, options?): Promise<any>
Fetching the WMS image.

Read more...
Parameters
- extent: EsriExtent
- width: number
- height: number
- Optional options: WMSLayerFetchImageOptions
Returns Promise<any>
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30834

findSublayerById

findSublayerById(id): EsriWMSSublayer
Returns a WMSSublayer based on the given sublayer id.

Read more...
Parameters
- id: number
Returns EsriWMSSublayer
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30840

findSublayerByName

findSublayerByName(name): EsriWMSSublayer
Returns a WMSSublayer based on the given sublayer name.

Read more...
Parameters
- name: string
Returns EsriWMSSublayer
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30846

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Layer.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Layer.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasEventListener

hasEventListener(type): boolean
Indicates whether there is an event listener on the instance that matches the provided event name.

Read more...
Parameters
- type: string
Returns boolean
Inherited from Layer.hasEventListener
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2069

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Layer.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

isFulfilled

isFulfilled(): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Read more...

Returns boolean
Inherited from Layer.isFulfilled
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2226

isRejected

isRejected(): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.

Read more...

Returns boolean
Inherited from Layer.isRejected
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2232

isResolved

isResolved(): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.

Read more...

Returns boolean
Inherited from Layer.isResolved
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2238

load

load(signal?): Promise<any>
Loads the resources referenced by this class.

Read more...
Parameters
- Optional signal: AbortSignal
Returns Promise<any>
Inherited from Layer.load
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2244

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Layer.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

on

on(name, eventHandler): IHandle
Parameters
- name: "refresh"
- eventHandler: WMSLayerRefreshEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30847
on(name, eventHandler): IHandle
Parameters
- name: "layerview-create"
- eventHandler: WMSLayerLayerviewCreateEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30848
on(name, eventHandler): IHandle
Parameters
- name: "layerview-create-error"
- eventHandler: WMSLayerLayerviewCreateErrorEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30849
on(name, eventHandler): IHandle
Parameters
- name: "layerview-destroy"
- eventHandler: WMSLayerLayerviewDestroyEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30850

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from Layer.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

refresh

refresh(): void
Fetches all the data for the layer.

Read more...

Returns void
Inherited from RefreshableLayer.refresh
- Defined in node_modules/@arcgis/core/interfaces.d.ts:16394

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Layer.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName, value): EsriWMSLayer
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriWMSLayer
Inherited from Layer.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriWMSLayer
Parameters
- props: HashMap<any>
Returns EsriWMSLayer
Inherited from Layer.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Layer.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

when

when(callback?, errback?): Promise<any>
when() may be leveraged once an instance of the class is created.

Read more...
Parameters
- Optional callback: Function
- Optional errback: Function
Returns Promise<any>
Inherited from Layer.when
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2250

`Static` fromJSON

fromJSON(json): EsriWMSLayer
Parameters
- json: any
Returns EsriWMSLayer
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30851

Class EsriWMSLayer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: WMSLayerProperties

Returns EsriWMSLayer

Properties

allSublayers

blendMode

Default

copyright

customLayerParameters

customParameters

declaredClass

description

destroyed

Readonly dimensions

effect

Default

featureInfoFormat

Readonly featureInfoFormats

featureInfoUrl

fetchFeatureInfoFunction

Default

fullExtent

fullExtents

id

imageFormat

imageMaxHeight

Default

imageMaxWidth

Default

imageTransparency

Default

initialized

legendEnabled

Default

listMode

Default

Readonly loadError

Default

Readonly loadStatus

Default

Readonly loadWarnings

Readonly loaded

Default

maxScale

Default

minScale

Default

opacity

Default

portalItem

refreshInterval

Default

spatialReference

spatialReferences

sublayers

timeExtent

timeInfo

Default

timeOffset

Default

title

Readonly type

url

useViewTime

Default

version

visible

Default

Methods

Protected _get

Parameters

propertyName: string

`Optional` properties: WMSLayerProperties

`Readonly` dimensions

`Readonly` featureInfoFormats

`Readonly` loadError

`Readonly` loadStatus

`Readonly` loadWarnings

`Readonly` loaded

`Readonly` type

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` options: LayerCreateLayerViewOptions

`Optional` event: any

`Optional` options: WMSLayerFetchImageOptions

`Optional` groupKey: Exclude<T, IHandle>