Skip to content

worldwind-ui API / react-worldwind / LayerProps

Interface: LayerProps ​

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

Extends ​

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 ​

UseLayerOptions.attribution


displayName? ​

optional displayName?: string

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

Inherited from ​

UseLayerOptions.displayName


enabled? ​

optional enabled?: boolean

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

Inherited from ​

UseLayerOptions.enabled


index? ​

optional index?: number

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

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

Inherited from ​

UseLayerOptions.index


kind ​

kind: BuiltInLayerKind

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

One of WorldWind's built-in layers, e.g. blue-marble-landsat, osm, atmosphere, compass.


legend? ​

optional legend?: string | LayerLegend | null

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

Legend image URL or descriptor.

Inherited from ​

UseLayerOptions.legend


maxActiveAltitude? ​

optional maxActiveAltitude?: number

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

Inherited from ​

UseLayerOptions.maxActiveAltitude


minActiveAltitude? ​

optional minActiveAltitude?: number

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

Inherited from ​

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

Inherited from ​

UseLayerOptions.onError


opacity? ​

optional opacity?: number

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

0..1

Inherited from ​

UseLayerOptions.opacity


pickEnabled? ​

optional pickEnabled?: boolean

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

Inherited from ​

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

UseLayerOptions.timeDimension

MIT licensed. Not affiliated with NASA; WorldWind is NASA's open-source virtual globe.