Class ElevationLayer<UserData>

A layer that provides elevation data to display terrains.

Type Parameters

UserData extends LayerUserData = LayerUserData

Hierarchy (View Summary)

Layer<LayerEvents, UserData>
- ElevationLayer

Constructors

constructor

new ElevationLayer<UserData extends LayerUserData = LayerUserData>(
options: ElevationLayerOptions,
): ElevationLayer<UserData>
Creates an elevation layer. See the example for more information on layer creation.
Type Parameters
- UserData extends LayerUserData = LayerUserData
Parameters
- options: ElevationLayerOptions
  The layer options.
Returns ElevationLayer<UserData>
Overrides Layer.constructor
- Defined in core/layer/ElevationLayer.ts:52

Properties

backgroundColor

backgroundColor: Color

`Readonly`colorMap

colorMap: ColorMap | null = null

The colormap of this layer

`Readonly`computeMinMax

computeMinMax: boolean

`Readonly`extent

extent: Extent | null = null

The extent of this layer

frozen

frozen: boolean = false

Disables automatic updates of this layer. Useful for debugging purposes.

`Readonly`id

id: string

The unique identifier of this layer.

`Readonly`interpretation

interpretation: Interpretation

`Readonly`isElevationLayer

isElevationLayer: boolean = true

Read-only flag to check if a given object is of type ElevationLayer.

`Readonly`isLayer

isLayer: boolean = true

Read-only flag to check if a given object is of type Layer.

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

minmax

minmax: { isDefault?: boolean; max: number; min: number }

`Readonly`name

name: string | undefined

Optional name of this layer.

`Readonly`noDataOptions

noDataOptions: NoDataOptions

`Readonly`resolutionFactor

resolutionFactor: number

The resolution factor applied to the textures generated by this layer.

`Readonly`showEmptyTextures

showEmptyTextures: boolean

`Readonly`showTileBorders

showTileBorders: boolean

`Readonly`source

source: ImageSource

The source of this layer

type

type: string

`Readonly`userData

userData: UserData

An object that can be used to store custom data about the Layer.

Accessors

`Protected`instance

get instance(): Instance
Returns Instance
Inherited from Layer.instance
- Defined in core/layer/Layer.ts:637

loading

get loading(): boolean
Gets whether the object is currently performing an asynchronous operation.

Returns boolean
Inherited from Layer.loading
- Defined in core/layer/Layer.ts:589

progress

get progress(): number
Returns the percentage of progress, in normalized value (i.e in the [0, 1] range), of the asynchronous operations that are scheduled to run on this object. 1 means that all operations have finished.

Returns number
Inherited from Layer.progress
- Defined in core/layer/Layer.ts:593

ready

get ready(): boolean
Returns boolean
Inherited from Layer.ready
- Defined in core/layer/Layer.ts:454

visible

get visible(): boolean
Gets or sets the visibility of this layer.

Returns boolean
Inherited from ColorLayer.visible
- Defined in core/layer/Layer.ts:577
set visible(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from ColorLayer.visible
- Defined in core/layer/Layer.ts:581

Methods

`Protected`adjustExtent

adjustExtent(extent: Extent): Extent
Parameters
- extent: Extent
Returns Extent
Overrides Layer.adjustExtent
- Defined in core/layer/ElevationLayer.ts:86

`Protected`adjustExtentAndPixelSize

adjustExtentAndPixelSize(
    originalExtent: Extent,
    originalWidth: number,
    originalHeight: number,
): GridExtent
Adjusts the extent to avoid visual artifacts.
Parameters
- originalExtent: Extent
  The original extent.
- originalWidth: number
  The width, in pixels, of the original extent.
- originalHeight: number
  The height, in pixels, of the original extent.
Returns GridExtent
And object containing the adjusted extent, as well as adjusted pixel size.
Inherited from Layer.adjustExtentAndPixelSize
- Defined in core/layer/Layer.ts:953

`Protected`applyEmptyTextureToNode

applyEmptyTextureToNode(target: Target): void
Parameters
- target: Target
Returns void
Overrides Layer.applyEmptyTextureToNode
- Defined in core/layer/ElevationLayer.ts:153

`Protected`applyInterimTexture

applyInterimTexture(target: Target): void
Immediately applies a temporary texture to the target while the actual texture is being asynchronously processed, to avoid displaying a black texture.
Parameters
- target: Target
Returns void
Inherited from Layer.applyInterimTexture
- Defined in core/layer/Layer.ts:1225

`Protected`applyTextureToNode

applyTextureToNode(textureAndPitch: TextureAndPitch, target: Target): void
Parameters
- textureAndPitch: TextureAndPitch
- target: Target
Returns void
Overrides Layer.applyTextureToNode
- Defined in core/layer/ElevationLayer.ts:130

clear

clear(extent?: Extent): void
Resets all render targets to a blank state and repaint all the targets.
Parameters
- Optionalextent: Extent
  An optional extent to limit the region to clear.
Returns void
Inherited from Layer.clear
- Defined in core/layer/Layer.ts:548

contains

contains(extent: Extent): boolean
Parameters
- extent: Extent
  The extent to test.
Returns boolean
true if this layer contains the specified extent, false otherwise.
Inherited from Layer.contains
- Defined in core/layer/Layer.ts:1497

dispose

dispose(): void
Disposes the layer. This releases all resources held by this layer.

Returns void
Inherited from Layer.dispose
- Defined in core/layer/Layer.ts:1606

getExtent

getExtent(): Extent | undefined
Returns the final extent of this layer. If this layer has its own extent defined, this will be used. Otherwise, will return the source extent (if any). May return undefined if not pre-processed yet.

Returns Extent | undefined
The layer final extent.
Inherited from Layer.getExtent
- Defined in core/layer/Layer.ts:693

getMemoryUsage

getMemoryUsage(context: GetMemoryUsageContext): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
Returns void
Inherited from Layer.getMemoryUsage
- Defined in core/layer/Layer.ts:458

getPixel

getPixel(
params: { coordinates: Coordinates; size?: number },
): Color[] | undefined
Get the pixels colors of this layer at coordinate. This will samples all pixel colors within a square region of specified size, centered at the given coordinate. Returns undefined if no non-transparent (colored) pixels are found, or if no texture is available for this coordinate.

Note: only 8-bit layers are supported. If the layer has non 8-bit pixels, returns undefined.
Parameters
- params: { coordinates: Coordinates; size?: number }
  - coordinates: Coordinates
    The coordinate to sample.
  - Optionalsize?: number
    The size, in pixels, of the square to sample
    
    Default Value
    1
Returns Color[] | undefined
The colors
Inherited from Layer.getPixel
- Defined in core/layer/Layer.ts:1012

getRenderTargetDataType

getRenderTargetDataType(): TextureDataType
Returns TextureDataType
Overrides Layer.getRenderTargetDataType
- Defined in core/layer/ElevationLayer.ts:72

getRenderTargetPixelFormat

getRenderTargetPixelFormat(): PixelFormat
Returns PixelFormat
Overrides Layer.getRenderTargetPixelFormat
- Defined in core/layer/ElevationLayer.ts:76

isLoaded

isLoaded(nodeId: number): boolean
Returns true if this layer has loaded data for this node.
Parameters
- nodeId: number
Returns boolean
Inherited from Layer.isLoaded
- Defined in core/layer/Layer.ts:1587

loadFallbackImages

loadFallbackImages(): Promise<void>
Returns Promise<void>
Inherited from Layer.loadFallbackImages
- Defined in core/layer/Layer.ts:757

loadFallbackImagesInternal

loadFallbackImagesInternal(): Promise<void>
Returns Promise<void>
Inherited from Layer.loadFallbackImagesInternal
- Defined in core/layer/Layer.ts:702

`Protected`onInitialized

onInitialized(): Promise<void>
Called when the layer has finished initializing.

Returns Promise<void>
Overrides Layer.onInitialized
- Defined in core/layer/ElevationLayer.ts:98

onRenderingContextLost

onRenderingContextLost(): void
Called when the rendering context has been lost.

Returns void
Inherited from Layer.onRenderingContextLost
- Defined in core/layer/Layer.ts:536

onRenderingContextRestored

onRenderingContextRestored(): void
Called when the rendering context has been restored.

Returns void
Inherited from Layer.onRenderingContextRestored
- Defined in core/layer/Layer.ts:540

`Protected`onTextureCreated

onTextureCreated(texture: Texture): void
Parameters
- texture: Texture
Returns void
Overrides Layer.onTextureCreated
- Defined in core/layer/ElevationLayer.ts:157

postUpdate

postUpdate(): void
Returns void
Inherited from Layer.postUpdate
- Defined in core/layer/Layer.ts:1563

unregisterNode

unregisterNode(node: TileMesh): void
Removes the node from this layer.
Parameters
- node: TileMesh
  The disposed node.
Returns void
Overrides Layer.unregisterNode
- Defined in core/layer/ElevationLayer.ts:111

update

update(context: Context, node: LayerNode): void
Updates the provided node with content from this layer.
Parameters
- context: Context
  the context
- node: LayerNode
  the node to update
Returns void
Inherited from Layer.update
- Defined in core/layer/Layer.ts:1422

`Protected`updateMaterial

updateMaterial(material: Material): void
Parameters
- material: Material
Returns void
Inherited from Layer.updateMaterial
- Defined in core/layer/Layer.ts:1580

Class ElevationLayer<UserData>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ElevationLayer<UserData>

Properties

backgroundColor

ReadonlycolorMap

ReadonlycomputeMinMax

Readonlyextent

frozen

Readonlyid

Readonlyinterpretation

ReadonlyisElevationLayer

ReadonlyisLayer

ReadonlyisMemoryUsage

minmax

Readonlyname

ReadonlynoDataOptions

ReadonlyresolutionFactor

ReadonlyshowEmptyTextures

ReadonlyshowTileBorders

Readonlysource

type

ReadonlyuserData

Accessors

Protectedinstance

Returns Instance

loading

Returns boolean

progress

Returns number

ready

Returns boolean

visible

Returns boolean

Parameters

Returns void

Methods

ProtectedadjustExtent

Parameters

Returns Extent

ProtectedadjustExtentAndPixelSize

Parameters

Returns GridExtent

ProtectedapplyEmptyTextureToNode

Parameters

Returns void

ProtectedapplyInterimTexture

Parameters

Returns void

ProtectedapplyTextureToNode

Parameters

Returns void

clear

Parameters

Returns void

contains

Parameters

Returns boolean

dispose

Returns void

getExtent

Returns Extent | undefined

getMemoryUsage

Parameters

Returns void

getPixel

Parameters

coordinates: Coordinates

Optionalsize?: number

Default Value

`Readonly`colorMap

`Readonly`computeMinMax

`Readonly`extent

`Readonly`id

`Readonly`interpretation

`Readonly`isElevationLayer

`Readonly`isLayer

`Readonly`isMemoryUsage

`Readonly`name

`Readonly`noDataOptions

`Readonly`resolutionFactor

`Readonly`showEmptyTextures

`Readonly`showTileBorders

`Readonly`source

`Readonly`userData

`Protected`instance

`Protected`adjustExtent

`Protected`adjustExtentAndPixelSize

`Protected`applyEmptyTextureToNode

`Protected`applyInterimTexture

`Protected`applyTextureToNode

`Optional`size?: number

`Protected`onInitialized

`Protected`onTextureCreated

`Protected`updateMaterial