Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WMSLayerProperties

Hierarchy

Index

Properties

Optional allSublayers

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

Read more...

Optional 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...

Optional copyright

copyright: string

Copyright information for the WMS service.

Read more...

Optional customLayerParameters

customLayerParameters: any

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

Read more...

Optional customParameters

customParameters: any

Use this to append custom parameters to all WMS requests.

Read more...

Optional description

description: string

Description for the WMS layer.

Read more...

Optional effect

effect: string | any[]

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...

Optional featureInfoFormat

featureInfoFormat: string

Return format of feature information (MIME type).

Read more...

Optional featureInfoUrl

featureInfoUrl: string

The URL for the WMS GetFeatureInfo call.

Read more...

Optional fullExtent

fullExtent: ExtentProperties

The full extent of the layer.

Read more...

Optional fullExtents

fullExtents: ExtentProperties[]

All bounding boxes defined for the layer.

Read more...

Optional id

id: string

The unique ID assigned to the layer.

Read more...

Optional imageFormat

imageFormat: string

The map image format (MIME type) to request.

Read more...

Optional imageMaxHeight

imageMaxHeight: number

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

Read more...

Optional imageMaxWidth

imageMaxWidth: number

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

Read more...

Optional imageTransparency

imageTransparency: boolean

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

Read more...

Optional legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

Optional listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Optional maxScale

maxScale: number

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

Read more...

Optional minScale

minScale: number

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

Read more...

Optional opacity

opacity: number

The opacity of the layer.

Read more...

Optional portalItem

The portal item from which the layer is loaded.

Read more...

Optional refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Read more...

Optional spatialReference

spatialReference: SpatialReferenceProperties

The spatial reference of the layer.

Read more...

Optional spatialReferences

spatialReferences: number[]

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

Read more...

Optional sublayers

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

Read more...

Optional timeExtent

The layer's time extent.

Read more...

Optional 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...

Optional timeOffset

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

Read more...

Optional title

title: string

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

Read more...

Optional url

url: string

The URL of the WMS service.

Read more...

Optional useViewTime

useViewTime: boolean

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

Read more...

Optional version

version: string

Version of the WMS specification to use.

Read more...

Optional visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Generated using TypeDoc