Class EsriWMSSublayer

Hierarchy

  • Accessor
  • Identifiable
    • EsriWMSSublayer

Constructors

  • Represents a sublayer in a WMSLayer.

    Read more...

    Parameters

    • Optional properties: WMSSublayerProperties

    Returns EsriWMSSublayer

Properties

declaredClass: string
description: string

Description for the WMS sublayer.

Read more...

destroyed: boolean
dimensions: (TimeDimension | ElevationDimension | GenericDimension)[]

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

Read more...

fullExtent: EsriExtent

The full extent of the layer.

Read more...

id: number

The id for the WMS sublayer.

Read more...

initialized: boolean

The WMSLayer to which the sublayer belongs.

Read more...

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-support-WMSSublayer.html#legendEnabled)
legendUrl: string

A string url pointing to a legend image for the layer.

Read more...

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-support-WMSSublayer.html#maxScale)
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-support-WMSSublayer.html#minScale)
name: string

Name of the WMS sublayer.

Read more...

parent: any

Returns a reference to the parent WMS sublayer or layer.

Read more...

popupEnabled: boolean

Indicates whether to display popups when features in the layer are clicked.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#popupEnabled)
queryable: boolean

Indicates if the layer can be queried, i.e.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#queryable)
spatialReferences: number[]

List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request.

Read more...

sublayers: Collection<EsriWMSSublayer>

A collection of WMSSublayers.

Read more...

title: string

The title of the WMS sublayer used to identify it in places such as the LayerList and Legend widgets.

Read more...

visible: boolean

Indicates if the layer is visible in the view.

Read more...

Methods

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriWMSSublayer

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

  • Parameters

    • propertyName: string

    Returns void

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriWMSSublayer

  • Parameters

    • props: HashMap<any>

    Returns EsriWMSSublayer

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc