Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WMSLayer

Hierarchy

Index

Properties

allSublayers

allSublayers: Collection<WMSSublayer>

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

Read more...

blendMode

blendMode: "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "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.

Read more...

copyright

copyright: string

Copyright information for the WMS service.

Read more...

customLayerParameters

customLayerParameters: any

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

Read more...

customParameters

customParameters: any

Use this to append custom parameters to all WMS requests.

Read more...

declaredClass

declaredClass: string

description

description: string

Description for the WMS layer.

Read more...

destroyed

destroyed: boolean

Readonly dimensions

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

Read more...

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.

Read more...

featureInfoFormat

featureInfoFormat: string

Return format of feature information (MIME type).

Read more...

featureInfoUrl

featureInfoUrl: string

The URL for the WMS GetFeatureInfo call.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

fullExtents

fullExtents: Extent[]

All bounding boxes defined for the layer.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

imageFormat

imageFormat: string

The map image format (MIME type) to request.

Read more...

imageMaxHeight

imageMaxHeight: number

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

Read more...

imageMaxWidth

imageMaxWidth: number

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

Read more...

imageTransparency

imageTransparency: boolean

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

Read more...

initialized

initialized: boolean

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

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

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Read more...

maxScale

maxScale: number

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

Read more...

minScale

minScale: number

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

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the layer.

Read more...

spatialReferences

spatialReferences: number[]

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

Read more...

sublayers

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

Read more...

timeExtent

timeExtent: TimeExtent

The layer's time extent.

Read more...

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.

Read more...

timeOffset

timeOffset: TimeInterval

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

Read more...

title

title: string

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

Read more...

Readonly type

type: "wms"

url

url: string

The URL of the WMS service.

Read more...

useViewTime

useViewTime: boolean

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

Read more...

version

version: string

Version of the WMS specification to use.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): WMSLayer
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns WMSLayer

cancelLoad

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

    Read more...

    Returns void

createLayerView

  • 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

    Returns Promise<LayerView>

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

emit

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

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

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

    Read more...

    Returns Promise<any>

fetchImage

  • Fetching the WMS image.

    Read more...

    Parameters

    Returns Promise<any>

findSublayerById

  • Returns a WMSSublayer based on the given sublayer id.

    Read more...

    Parameters

    • id: number

    Returns WMSSublayer

findSublayerByName

  • Returns a WMSSublayer based on the given sublayer name.

    Read more...

    Parameters

    • name: string

    Returns WMSSublayer

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

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

    Read more...

    Parameters

    • type: string

    Returns boolean

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

isRejected

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

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

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

refresh

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

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns WMSLayer

  • Parameters

    Returns WMSLayer

watch

  • Parameters

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

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): 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>

Generated using TypeDoc