worldwind-ui API / react-worldwind / WmsLayerProps

Interface: WmsLayerProps

Defined in: react/src/layers.tsx:39

Extends

• WmsLayerOptions

Properties

attribution?

optional attribution?: string | LayerAttribution | null

Defined in: kit/src/layers.ts:86

Credit for the layer's data; null suppresses the default of a built-in layer.

Inherited from

WmsLayerOptions.attribution

---

coordinateSystem?

optional coordinateSystem?: string

Defined in: kit/src/layers.ts:263

Inherited from

WmsLayerOptions.coordinateSystem

---

displayName?

optional displayName?: string

Defined in: kit/src/layers.ts:78

Inherited from

WmsLayerOptions.displayName

---

enabled?

optional enabled?: boolean

Defined in: kit/src/layers.ts:79

Inherited from

WmsLayerOptions.enabled

---

format?

optional format?: string

Defined in: kit/src/layers.ts:254

Defaults to image/png.

Inherited from

WmsLayerOptions.format

---

fromCapabilities?

optional fromCapabilities?: boolean

Defined in: react/src/layers.tsx:45

Read the sector, formats and tiling from the service's GetCapabilities document instead of the props; layerNames is then the single layer name to look up.

---

index?

optional index?: number

Defined in: react/src/layers.tsx:40

---

layerNames

layerNames: string

Defined in: kit/src/layers.ts:251

Comma-separated WMS layer names.

Inherited from

WmsLayerOptions.layerNames

---

legend?

optional legend?: string | LayerLegend | null

Defined in: kit/src/layers.ts:88

Legend image URL or descriptor.

Inherited from

WmsLayerOptions.legend

---

levelZeroDelta?

optional levelZeroDelta?: number

Defined in: kit/src/layers.ts:262

Tile delta in degrees at level 0. Defaults to 36.

Inherited from

WmsLayerOptions.levelZeroDelta

---

maxActiveAltitude?

optional maxActiveAltitude?: number

Defined in: kit/src/layers.ts:84

Inherited from

WmsLayerOptions.maxActiveAltitude

---

minActiveAltitude?

optional minActiveAltitude?: number

Defined in: kit/src/layers.ts:83

Inherited from

WmsLayerOptions.minActiveAltitude

---

numLevels?

optional numLevels?: number

Defined in: kit/src/layers.ts:258

Defaults to 19.

Inherited from

WmsLayerOptions.numLevels

---

onError?

optional onError?: (error) => void

Defined in: react/src/layers.tsx:46

Parameters

error

unknown

Returns

void

---

opacity?

optional opacity?: number

Defined in: kit/src/layers.ts:81

0..1

Inherited from

WmsLayerOptions.opacity

---

pickEnabled?

optional pickEnabled?: boolean

Defined in: kit/src/layers.ts:82

Inherited from

WmsLayerOptions.pickEnabled

---

sector?

optional sector?: SectorInput

Defined in: kit/src/layers.ts:260

Coverage of the layer. Defaults to the whole globe.

Inherited from

WmsLayerOptions.sector

---

service

service: string

Defined in: kit/src/layers.ts:249

WMS endpoint, e.g. https://example.org/geoserver/wms.

Inherited from

WmsLayerOptions.service

---

size?

optional size?: number

Defined in: kit/src/layers.ts:256

Tile size in pixels. Defaults to 256.

Inherited from

WmsLayerOptions.size

---

styleNames?

optional styleNames?: string

Defined in: kit/src/layers.ts:252

Inherited from

WmsLayerOptions.styleNames

---

time?

optional time?: string | null

Defined in: kit/src/layers.ts:267

Value for the WMS TIME dimension.

Inherited from

WmsLayerOptions.time

---

timeDimension?

optional timeDimension?: TimeDimension | null

Defined in: kit/src/layers.ts:90

The instants the layer can show, for time sliders. Read from capabilities when available.

Inherited from

WmsLayerOptions.timeDimension

---

version?

optional version?: string

Defined in: kit/src/layers.ts:265

WMS protocol version, e.g. 1.3.0.

Inherited from

WmsLayerOptions.version