Class Layer<TEvents, TUserData>`Abstract`

Base class of layers. Layers are components of maps or any compatible entity.

The same layer can be added to multiple entities. Don't forget to call dispose when the layer should be destroyed, as removing a layer from an entity will not release memory associated with the layer (such as textures).

Layer nodes

Layers generate textures to be applied to nodes. Nodes might be map tiles, point cloud tiles or any object that matches the definition of the interface.

Types of layers

Layer is an abstract class. See subclasses for specific information. Main subclasses:

ColorLayer for color information, such as satellite imagery, vector data, etc.
ElevationLayer for elevation and terrain data.
MaskLayer: a special kind of layer that applies a mask on its host map.

The `userData` property

The userData property can be used to attach custom data to the layer, in a type safe manner. It is recommended to use this property instead of attaching arbitrary properties to the object:

type MyCustomUserData = {
  creationDate: Date;
  owner: string;
};
const newLayer = new ColorLayer<MyCustomUserData>({ ... });

newLayer.userData.creationDate = Date.now();
newLayer.userData.owner = 'John Doe';

Reprojection capabilities

When the source of the layer has a different coordinate system (CRS) than the instance, the images from the source will be reprojected to the instance CRS.

Note that doing so will have a performance cost in both CPU and memory.

// Add and create a new Layer to an existing map.
const newLayer = new ColorLayer({ ... });

await map.addLayer(newLayer);

// Change layer's visibilty
newLayer.visible = false;
instance.notifyChange(); // update instance

// Change layer's opacity
newLayer.opacity = 0.5;
instance.notifyChange(); // update instance

// Listen to properties
newLayer.addEventListener('visible-property-changed', (event) => console.log(event));

Type Parameters

TEvents extends LayerEvents = LayerEvents
The event map of the layer.
TUserData extends LayerUserData = LayerUserData
The type of the userData property.

Hierarchy (view full)

EventDispatcher<TEvents & LayerEvents>
- Layer
  - ColorLayer
  - ElevationLayer

Implements

Constructors

constructor

new Layer<TEvents, TUserData>(options): Layer<TEvents, TUserData>
Creates a layer.
Type Parameters
- TEvents extends LayerEvents = LayerEvents
- TUserData extends LayerUserData = LayerUserData
Parameters
- options: LayerOptions
  The layer options.
Returns Layer<TEvents, TUserData>
Overrides EventDispatcher.constructor
- Defined in core/layer/Layer.ts:461

Properties

backgroundColor

backgroundColor: Color

`Readonly`colorMap

colorMap: null | ColorMap = null

The colormap of this layer

`Readonly`computeMinMax

computeMinMax: boolean

`Readonly`extent

extent: null | Extent = 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`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.

`Readonly`name

name: undefined | string

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

The source of this layer

type

type: string

`Readonly`userData

userData: TUserData

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

Accessors

`Protected`instance

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

loading

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

Returns boolean
Implementation of Progress.loading
- Defined in core/layer/Layer.ts:577

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
Implementation of Progress.progress
- Defined in core/layer/Layer.ts:581

ready

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

visible

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

Returns boolean
- Defined in core/layer/Layer.ts:565
set visible(v): void
Parameters
- v: boolean
Returns void
- Defined in core/layer/Layer.ts:569

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(TEvents & LayerEvents)[T], T, Layer<TEvents, TUserData>>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

`Protected`adjustExtent

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

`Protected`adjustExtentAndPixelSize

adjustExtentAndPixelSize(originalExtent, originalWidth, originalHeight): {
    extent: Extent;
    height: number;
    width: number;
}
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 {
    extent: Extent;
    height: number;
    width: number;
}
And object containing the adjusted extent, as well as adjusted pixel size.
- extent: Extent
- height: number
- width: number
- Defined in core/layer/Layer.ts:937

`Protected` `Abstract`applyEmptyTextureToNode

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

`Protected`applyInterimTexture

applyInterimTexture(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
- Defined in core/layer/Layer.ts:1146

`Protected` `Abstract`applyTextureToNode

applyTextureToNode(texture, target, isLastRender): void
Parameters
- texture: TextureAndPitch
- target: Target
- isLastRender: boolean
Returns void
- Defined in core/layer/Layer.ts:1516

clear

clear(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
- Defined in core/layer/Layer.ts:536

contains

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

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends string
Parameters
- event: BaseEvent<T> & (TEvents & LayerEvents)[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

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

Returns void
Implementation of Disposable.dispose
- Defined in core/layer/Layer.ts:1527

getExtent

getExtent(): undefined | Extent
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 undefined | Extent
The layer final extent.
- Defined in core/layer/Layer.ts:677

getMemoryUsage

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

`Abstract`getRenderTargetDataType

getRenderTargetDataType(): TextureDataType
Returns TextureDataType
- Defined in core/layer/Layer.ts:1431

`Abstract`getRenderTargetPixelFormat

getRenderTargetPixelFormat(): PixelFormat
Returns PixelFormat
- Defined in core/layer/Layer.ts:1429

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(TEvents & LayerEvents)[T], T, Layer<TEvents, TUserData>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

isLoaded

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

loadFallbackImages

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

loadFallbackImagesInternal

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

`Protected`onInitialized

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

Returns Promise<void>
- Defined in core/layer/Layer.ts:757

onRenderingContextLost

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

Returns void
Implementation of RenderingContextHandler.onRenderingContextLost
- Defined in core/layer/Layer.ts:524

onRenderingContextRestored

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

Returns void
Implementation of RenderingContextHandler.onRenderingContextRestored
- Defined in core/layer/Layer.ts:528

`Protected`onTextureCreated

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

postUpdate

postUpdate(): void
Returns void
- Defined in core/layer/Layer.ts:1484

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<(TEvents & LayerEvents)[T], T, Layer<TEvents, TUserData>>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

unregisterNode

unregisterNode(node, immediate?): void
Removes the node from this layer.
Parameters
- node: LayerNode
  The disposed node.
- immediate: boolean = false
Returns void
- Defined in core/layer/Layer.ts:911

update

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

`Protected`updateMaterial

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

Class Layer<TEvents, TUserData>Abstract

Layer nodes

Types of layers

The userData property

Reprojection capabilities

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Layer<TEvents, TUserData>

Properties

backgroundColor

ReadonlycolorMap

ReadonlycomputeMinMax

Readonlyextent

frozen

Readonlyid

Readonlyinterpretation

ReadonlyisLayer

ReadonlyisMemoryUsage

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

addEventListener

Type Parameters

Parameters

Returns void

ProtectedadjustExtent

Parameters

Returns Extent

ProtectedadjustExtentAndPixelSize

Parameters

Returns { extent: Extent; height: number; width: number; }

extent: Extent

height: number

width: number

Protected AbstractapplyEmptyTextureToNode

Parameters

Returns void

ProtectedapplyInterimTexture

Parameters

Returns void

Protected AbstractapplyTextureToNode

Parameters

Returns void

clear

Parameters

Returns void

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Class Layer<TEvents, TUserData>`Abstract`

The `userData` property

`Readonly`colorMap

`Readonly`computeMinMax

`Readonly`extent

`Readonly`id

`Readonly`interpretation

`Readonly`isLayer

`Readonly`isMemoryUsage

`Readonly`name

`Readonly`noDataOptions

`Readonly`resolutionFactor

`Readonly`showEmptyTextures

`Readonly`showTileBorders

`Readonly`source

`Readonly`userData

`Protected`instance

`Protected`adjustExtent

`Protected`adjustExtentAndPixelSize

Returns {
extent: Extent;
height: number;
width: number;
}

`Protected` `Abstract`applyEmptyTextureToNode

`Protected`applyInterimTexture

`Protected` `Abstract`applyTextureToNode

`Abstract`getRenderTargetDataType

`Abstract`getRenderTargetPixelFormat

`Protected`onInitialized

`Protected`onTextureCreated

`Protected`updateMaterial