worldwind-ui API / react-worldwind / UseLayerOptions

Interface: UseLayerOptions

Defined in: react/src/hooks.ts:151

Extends

• LayerOptions

Extended by

• CustomLayerProps
• GeoJsonLayerProps
• KmlLayerProps
• LayerProps
• RenderableLayerProps

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

LayerOptions.attribution

---

displayName?

optional displayName?: string

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

Inherited from

LayerOptions.displayName

---

enabled?

optional enabled?: boolean

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

Inherited from

LayerOptions.enabled

---

index?

optional index?: number

Defined in: react/src/hooks.ts:153

Position in the layer stack (0 = bottom). Applied on creation only.

---

legend?

optional legend?: string | LayerLegend | null

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

Legend image URL or descriptor.

Inherited from

LayerOptions.legend

---

maxActiveAltitude?

optional maxActiveAltitude?: number

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

Inherited from

LayerOptions.maxActiveAltitude

---

minActiveAltitude?

optional minActiveAltitude?: number

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

Inherited from

LayerOptions.minActiveAltitude

---

onError?

optional onError?: (error) => void

Defined in: react/src/hooks.ts:155

Called when an asynchronous create rejects. Defaults to console.error.

Parameters

error

unknown

Returns

void

---

opacity?

optional opacity?: number

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

0..1

Inherited from

LayerOptions.opacity

---

pickEnabled?

optional pickEnabled?: boolean

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

Inherited from

LayerOptions.pickEnabled

---

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

LayerOptions.timeDimension