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.
The layer options.
Protected
_composerPrivate
_maskProtected
Readonly
_queueReadonly
colorThe colormap of this layer
Readonly
computeReadonly
extentThe extent of this layer
Disables automatic updates of this layer. Useful for debugging purposes.
Readonly
idThe unique identifier of this layer.
Readonly
interpretationReadonly
isRead-only flag to check if a given object is of type ColorLayer.
Readonly
isRead-only flag to check if a given object is of type Layer.
Readonly
isRead-only flag to check if a given object is of type MaskLayer.
Readonly
isReadonly
nameOptional name of this layer.
Readonly
noReadonly
resolutionThe resolution factor applied to the textures generated by this layer.
Readonly
showReadonly
sourceThe source of this layer
Readonly
userAn object that can be used to store custom data about the Layer.
Gets or sets the brightness of this layer.
Gets the colorimetry parameters of this layer.
Gets or sets the contrast of this layer.
Gets the elevation range of this layer, if any.
Sets the elevation range of this layer. Setting it to null removes the elevation range.
Gets whether the object is currently performing an asynchronous operation.
Gets or set the mask mode.
Gets or sets the opacity of this layer.
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.
Gets or sets the saturation of this layer.
Gets or sets the visibility of this layer.
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Protected
adjustProtected
adjustAdjusts the extent to avoid visual artifacts.
The original extent.
The width, in pixels, of the original extent.
The height, in pixels, of the original extent.
And object containing the adjusted extent, as well as adjusted pixel size.
Protected
applyProtected
applyProtected
canThe extent to test.
true
if this layer contains the specified extent, false
otherwise.
Fire an event type.
The event that gets fired.
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).
Array of features intersecting the extent (can be empty)
Checks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Protected
onProtected
onGiven a PickResult, returns and assigns its features.
Implementations must set pickedResult.features
to the returned result.
Picked result
Optional
options: PickOptionsOptions
Features
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Updates the provided node with content from this layer.
the context
the node to update
Protected
updateGenerated using TypeDoc
A ColorLayer that can be used to mask parts of a map. The source can be any source supported by the color layers.