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

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: ColorMap

The colormap of this layer

`Readonly` computeMinMax

computeMinMax: boolean

disposed

disposed: boolean

`Readonly` extent

extent: Extent

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

isPickableFeatures: true = true

`Readonly` name

name: 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

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

brightness

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

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

colorimetry

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

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

composer

get composer(): Readonly<LayerComposer>
Returns Readonly<LayerComposer>
Inherited from ColorLayer.composer
- Defined in core/layer/Layer.ts:1178

contrast

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

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

elevationRange

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

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

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:501

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:97
set opacity(v): void
Parameters
- v: number
Returns void
Inherited from ColorLayer.opacity
- Defined in core/layer/ColorLayer.ts:101

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:505

ready

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

saturation

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

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

visible

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

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

Methods

`Protected` adjustExtent

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

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

`Protected` applyDefaultTexture

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

applyEmptyTextureToNode

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

`Protected` applyTextureToNode

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

`Protected` canFetchImages

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

clear

clear(): void
Resets all render targets to a blank state and repaint all the targets.

Returns void
Inherited from ColorLayer.clear
- Defined in core/layer/Layer.ts:470

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:1076

`Protected` deleteUnusedTargets

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

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:1198

getExtent

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

getMemoryUsage

getMemoryUsage(context, target?): MemoryUsageReport
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
- Optional target: MemoryUsageReport
  If specified, the values computed during this call must be added to the existing values in the target. Otherwise, a new report must be built.
Returns MemoryUsageReport
The memory usage report. If target is specified, then this must be returned.
Inherited from ColorLayer.getMemoryUsage
- Defined in core/layer/Layer.ts:380

getRenderTargetDataType

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

getRenderTargetPixelFormat

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

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:91

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:96

loadFallbackImages

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

loadFallbackImagesInternal

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

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

`Protected` onTextureCreated

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

pickFeaturesFrom

pickFeaturesFrom(pickedResult, options?): VectorPickFeature[]
Parameters
- pickedResult: MapPickResult<unknown>
- Optional options: PickOptions
Returns VectorPickFeature[]
Inherited from ColorLayer.pickFeaturesFrom
- Defined in core/layer/ColorLayer.ts:215

postUpdate

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

unregisterNode

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

update

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

`Protected` updateMaterial

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

Class MaskLayer<UserData>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MaskLayer<UserData>

Properties

backgroundColor

Readonly colorMap

Readonly computeMinMax

disposed

Readonly extent

frozen

Readonly id

Readonly interpretation

Readonly isColorLayer

Readonly isLayer

Readonly isMaskLayer

Readonly isPickableFeatures

Readonly name

Readonly noDataOptions

Readonly resolutionFactor

Readonly showEmptyTextures

Readonly showTileBorders

Readonly source

type

Readonly userData

Accessors

brightness

Returns number

Parameters

Returns void

colorimetry

Returns ColorimetryOptions

composer

Returns Readonly<LayerComposer>

contrast

Returns number

Parameters

Returns void

elevationRange

Returns ElevationRange

Parameters

Returns void

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

Protected adjustExtent

Parameters

Returns Extent

Protected adjustExtentAndPixelSize

Parameters

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

`Readonly` colorMap

`Readonly` computeMinMax

`Readonly` extent

`Readonly` id

`Readonly` interpretation

`Readonly` isColorLayer

`Readonly` isLayer

`Readonly` isMaskLayer

`Readonly` isPickableFeatures

`Readonly` name

`Readonly` noDataOptions

`Readonly` resolutionFactor

`Readonly` showEmptyTextures

`Readonly` showTileBorders

`Readonly` source

`Readonly` userData

`Protected` adjustExtent

`Protected` adjustExtentAndPixelSize

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

`Protected` applyDefaultTexture

`Protected` applyTextureToNode

`Protected` canFetchImages

`Protected` deleteUnusedTargets

`Protected` onInitialized

`Protected` onTextureCreated

`Protected` updateMaterial