Class MaskLayer<UserData>

A ColorLayer that can be used to mask parts of a map. The source can be any source supported by the color layers.

Type Parameters

UserData extends LayerUserData = LayerUserData

Hierarchy (view full)

ColorLayer<UserData>
- MaskLayer

Index

Constructors

constructor

Accessors

blendingMode brightness colorimetry contrast elevationRange instance loading maskMode opacity progress ready saturation visible

Constructors

constructor

new MaskLayer<UserData>(options): MaskLayer<UserData>
Creates a mask layer. It should be added in a Map to be displayed in the instance. See the example for more information on layer creation.
Type Parameters
- UserData extends LayerUserData = LayerUserData
Parameters
- options: MaskLayerOptions
  The layer options.
Returns MaskLayer<UserData>
Overrides ColorLayer.constructor
- Defined in core/layer/MaskLayer.ts:51

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`isColorLayer

isColorLayer: boolean = true

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

`Readonly`isLayer

isLayer: boolean = true

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

`Readonly`isMaskLayer

isMaskLayer: boolean = true

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

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isPickableFeatures

isPickableFeatures = true

`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: UserData

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

Accessors

blendingMode

get blendingMode(): BlendingMode
Gets or sets the blending mode of this layer.

Returns BlendingMode
Inherited from ColorLayer.blendingMode
- Defined in core/layer/ColorLayer.ts:109
set blendingMode(v): void
Parameters
- v: BlendingMode
Returns void
Inherited from ColorLayer.blendingMode
- Defined in core/layer/ColorLayer.ts:113

brightness

get brightness(): number
Gets or sets the brightness of this layer.

Returns number
Inherited from ColorLayer.brightness
- Defined in core/layer/ColorLayer.ts:144
set brightness(v): void
Parameters
- v: number
Returns void
Inherited from ColorLayer.brightness
- Defined in core/layer/ColorLayer.ts:148

colorimetry

get colorimetry(): ColorimetryOptions
Gets the colorimetry parameters of this layer.

Returns ColorimetryOptions
Inherited from ColorLayer.colorimetry
- Defined in core/layer/ColorLayer.ts:137

contrast

get contrast(): number
Gets or sets the contrast of this layer.

Returns number
Inherited from ColorLayer.contrast
- Defined in core/layer/ColorLayer.ts:158
set contrast(v): void
Parameters
- v: number
Returns void
Inherited from ColorLayer.contrast
- Defined in core/layer/ColorLayer.ts:162

elevationRange

get elevationRange(): null | ElevationRange
Gets the elevation range of this layer, if any.

Returns null | ElevationRange
Inherited from ColorLayer.elevationRange
- Defined in core/layer/ColorLayer.ts:94
set elevationRange(range): void
Sets the elevation range of this layer. Setting it to null removes the elevation range.
Parameters
- range: null | ElevationRange
Returns void
Inherited from ColorLayer.elevationRange
- Defined in core/layer/ColorLayer.ts:101

`Protected`instance

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

loading

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

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

maskMode

get maskMode(): MaskMode
Gets or set the mask mode.

Returns MaskMode
- Defined in core/layer/MaskLayer.ts:61
set maskMode(v): void
Parameters
- v: MaskMode
Returns void
- Defined in core/layer/MaskLayer.ts:65

opacity

get opacity(): number
Gets or sets the opacity of this layer.

Returns number
Inherited from ColorLayer.opacity
- Defined in core/layer/ColorLayer.ts:123
set opacity(v): void
Parameters
- v: number
Returns void
Inherited from ColorLayer.opacity
- Defined in core/layer/ColorLayer.ts:127

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 ColorLayer.progress
- Defined in core/layer/Layer.ts:553

ready

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

saturation

get saturation(): number
Gets or sets the saturation of this layer.

Returns number
Inherited from ColorLayer.saturation
- Defined in core/layer/ColorLayer.ts:172
set saturation(v): void
Parameters
- v: number
Returns void
Inherited from ColorLayer.saturation
- Defined in core/layer/ColorLayer.ts:176

visible

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

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

Methods

addEventListener

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

`Protected`adjustExtent

adjustExtent(extent): Extent
Parameters
- extent: Extent
Returns Extent
Inherited from ColorLayer.adjustExtent
- Defined in core/layer/Layer.ts:871

`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
Inherited from ColorLayer.adjustExtentAndPixelSize
- Defined in core/layer/Layer.ts:883

`Protected`applyDefaultTexture

applyDefaultTexture(target): void
Parameters
- target: Target
  The target.
Returns void
Inherited from ColorLayer.applyDefaultTexture
- Defined in core/layer/Layer.ts:960

applyEmptyTextureToNode

applyEmptyTextureToNode(target): void
Parameters
- target: Target
Returns void
Overrides ColorLayer.applyEmptyTextureToNode
- Defined in core/layer/MaskLayer.ts:73

`Protected`applyTextureToNode

applyTextureToNode(result, target): void
Parameters
- result: TextureAndPitch
- target: Target
Returns void
Inherited from ColorLayer.applyTextureToNode
- Defined in core/layer/ColorLayer.ts:231

`Protected`canFetchImages

canFetchImages(target): boolean
Parameters
- target: Target
Returns boolean
Inherited from ColorLayer.canFetchImages
- Defined in core/layer/ColorLayer.ts:211

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
Inherited from ColorLayer.clear
- Defined in core/layer/Layer.ts:508

contains

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

`Protected`deleteUnusedTargets

deleteUnusedTargets(): void
Returns void
Inherited from ColorLayer.deleteUnusedTargets
- Defined in core/layer/Layer.ts:1260

dispatchEvent

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

dispose

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

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

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.
Inherited from ColorLayer.getExtent
- Defined in core/layer/Layer.ts:644

getMemoryUsage

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

getRenderTargetDataType

getRenderTargetDataType(): TextureDataType
Returns TextureDataType
Overrides ColorLayer.getRenderTargetDataType
- Defined in core/layer/MaskLayer.ts:69

getRenderTargetPixelFormat

getRenderTargetPixelFormat(): PixelFormat
Returns PixelFormat
Inherited from ColorLayer.getRenderTargetPixelFormat
- Defined in core/layer/ColorLayer.ts:207

getVectorFeaturesAtCoordinate

getVectorFeaturesAtCoordinate(): Feature<Geometry>[]
Returns all features at some coordinates, with an optional hit tolerance radius.

Returns Feature<Geometry>[]
Array of features at coordinates (can be empty)
Overrides ColorLayer.getVectorFeaturesAtCoordinate
- Defined in core/layer/MaskLayer.ts:89

getVectorFeaturesInExtent

getVectorFeaturesInExtent(): Feature<Geometry>[]
Get all features whose bounding box intersects the provided extent. Note that this returns an array of all features intersecting the given extent in random order (so it may include features whose geometries do not intersect the extent).

Returns Feature<Geometry>[]
Array of features intersecting the extent (can be empty)
Overrides ColorLayer.getVectorFeaturesInExtent
- Defined in core/layer/MaskLayer.ts:93

hasEventListener

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

loadFallbackImages

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

loadFallbackImagesInternal

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

`Protected`onInitialized

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

Returns Promise<void>
Inherited from ColorLayer.onInitialized
- Defined in core/layer/Layer.ts:721

onRenderingContextLost

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

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

onRenderingContextRestored

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

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

`Protected`onTextureCreated

onTextureCreated(texture): void
Parameters
- texture: Texture
Returns void
Inherited from ColorLayer.onTextureCreated
- Defined in core/layer/Layer.ts:690

pickFeaturesFrom

pickFeaturesFrom(pickedResult, options?): VectorPickFeature[]
Given a PickResult, returns and assigns its features.

Implementations must set pickedResult.features to the returned result.
Parameters
- pickedResult: MapPickResult<unknown>
  Picked result
- Optionaloptions: PickOptions
  Options
Returns VectorPickFeature[]
Features
Inherited from ColorLayer.pickFeaturesFrom
- Defined in core/layer/ColorLayer.ts:245

postUpdate

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

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof ColorLayerEvents
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<(ColorLayerEvents & LayerEvents)[T], T, MaskLayer<UserData>>
  The listener function that gets removed.
Returns void
Inherited from ColorLayer.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, MaskLayer<UserData>>
Returns void
Inherited from ColorLayer.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

unregisterNode

unregisterNode(node): void
Removes the node from this layer.
Parameters
- node: LayerNode
  The disposed node.
Returns void
Inherited from ColorLayer.unregisterNode
- Defined in core/layer/ColorLayer.ts:221

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
Inherited from ColorLayer.update
- Defined in core/layer/Layer.ts:1129

`Protected`updateMaterial

updateMaterial(material): void
Parameters
- material: LayerNodeMaterial
Returns void
Inherited from ColorLayer.updateMaterial
- Defined in core/layer/ColorLayer.ts:183

Class MaskLayer<UserData>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MaskLayer<UserData>

Properties

backgroundColor

ReadonlycolorMap

ReadonlycomputeMinMax

Readonlyextent

frozen

Readonlyid

Readonlyinterpretation

ReadonlyisColorLayer

ReadonlyisLayer

ReadonlyisMaskLayer

ReadonlyisMemoryUsage

ReadonlyisPickableFeatures

Readonlyname

ReadonlynoDataOptions

ReadonlyresolutionFactor

ReadonlyshowEmptyTextures

ReadonlyshowTileBorders

Readonlysource

type

ReadonlyuserData

Accessors

blendingMode

Returns BlendingMode

Parameters

Returns void

brightness

Returns number

Parameters

Returns void

colorimetry

Returns ColorimetryOptions

contrast

Returns number

Parameters

Returns void

elevationRange

Returns null | ElevationRange

Parameters

Returns void

Protectedinstance

Returns Instance

loading

Returns boolean

maskMode

Returns MaskMode

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

progress

Returns number

ready

Returns boolean

saturation

Returns number

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

Methods

addEventListener

Type Parameters

`Readonly`colorMap

`Readonly`computeMinMax

`Readonly`extent

`Readonly`id

`Readonly`interpretation

`Readonly`isColorLayer

`Readonly`isLayer

`Readonly`isMaskLayer

`Readonly`isMemoryUsage

`Readonly`isPickableFeatures

`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`applyDefaultTexture

`Protected`applyTextureToNode

`Protected`canFetchImages

`Protected`deleteUnusedTargets

`Protected`onInitialized