Abstract
The event map of the layer.
The type of the userData
property.
Creates a layer.
The layer options.
Readonly
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 Layer.
Readonly
nameOptional name of this layer.
Readonly
noReadonly
resolutionThe resolution factor applied to the textures generated by this layer.
Readonly
showReadonly
showReadonly
sourceThe source of this layer
Readonly
userAn object that can be used to store custom data about the Layer.
Gets whether the object is currently performing an asynchronous operation.
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 visibility of this layer.
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
Abstract
applyProtected
Abstract
applyProtected
Abstract
canResets all render targets to a blank state and repaint all the targets.
Optional
extent: ExtentAn optional extent to limit the region to clear.
The extent to test.
true
if this layer contains the specified extent, false
otherwise.
Protected
deleteReturns an approximation of the memory used by this object, in bytes.
The graphics context.
Optional
target: MemoryUsageReportIf specified, the values computed during this call must be added to the existing values in the target. Otherwise, a new report must be built.
The memory usage report. If target is specified, then this must be returned.
Abstract
getAbstract
getProtected
onProtected
onUpdates the provided node with content from this layer.
the context
the node to update
Protected
update
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).
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
propertyThe
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: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.