Abstract
Protected
constructorConstructor for a raster layer.
the model for the layer.
Optional
options: LayerConstructorOptionsthe layer options.
The content provider that may be used when showBalloon is called on the map. The content provider is a function that takes a single parameter and returns the contents for the balloon. The parameter is the object for which the balloon is shown, which is typically a Feature. The return value of the function can be a string or a DOM-node.
See showBalloon for information on how to style the balloon.
The list of direct children of the node. The children are ordered according to the painting order (the bottom layer is the first element in the array). Note that also the nodes that are not visible will be included.
Denotes whether the layer can be edited
The node's ID (immutable). This ID was configured at construction time and is unique over the whole layer tree. If no ID was given, a UUID will have been generated automatically.
The node's label. This label was configured at construction time. If no label was given, the label will correspond to the layer's ID.
The model of this layer, immutable.
The parent of this node or null
. This property
will be null
if this node has not been added as the child of another
node yet.
The raster style for this layer.
Denotes what PaintRepresentations are available for this layer. This usually depends on the type of layer or the painter configuration on the layer
Denotes whether the node is visible. This can be considered to be the master visibility switch: Setting this to false makes the layer entirely invisible. If it is true, the visible paint representations will be visible.
This property does not reflect whether this node's parent is visible as well, If this is desired, use visibleInTree instead.
Denotes whether this layer is visible on the map. This method will only return true if this layer and every parent layer up to the root of the layer tree is visible.
If visibleInTree is set to true, this will ensure that every parent LayerTreeNode up to the of the tree is configured to be visible as well.
Returns the layer with the given ID if that layer is this node or one of its children. Note that the layer's ID does not correspond with the layer's label.
The id of the layer that you want to retrieve.
the requested layer or undefined if it is not present in the tree
Returns the layer group with the given ID if that layer is this node or one of its children.
The id of the layer group that you want to retrieve.
the requested layer group or undefined if it is not present in the tree
2014.0
Returns the layer tree node with the given ID if that layer is this node or one of its children. This may be a layer-group or a layer.
The id of the layerTreeNode that you want to retrieve.
the requested layerTreeNode or undefined if it is not present in the tree
2014.0
Indicates whether the specified paint representation is supported for this layer. Not every LayerTreeNode may support all paint representations. E.g. raster layers may not b have a PaintRepresentation.LABEL paint representation.
the paint representation
true
when paintRepresentation
is supported,
false
otherwise.
Indicates whether the specified paint representation is visible.
The paint representation
true
when paintRepresentation
is supported
and visible, false
otherwise
Indicates whether the specified paint representation is visible on the map. This method will only return true if this paint representation is visible for this layer and every parent layer up to the layer tree.
The paint representation
true
when paintRepresentation
is supported
and visible, false
otherwise
Called when the map has detected a single click on an object that is contained by this layer. This method
can be overridden to take action when the click is detected. The default implementation of this method
simply returns false
.
the object that was clicked on
true to indicate that the click was handled and default behavior should not occur; false otherwise
Called when the map is going to display a context menu for an object that is contained by this layer. This method can be overridden to populate the given context menu with additional items.
The context menu to populate
The map that is about to show a context menu
The object that was passed to the map when requesting the context menu. The context menu info object. This object may contain arbitrary data. The default implementation expects a pickInfo object which will be passed to the appropriate Layer's onCreateContextMenu method. A pickInfo object is JavaScript object with two properties: the objects that were touched (an array of Features) and the layer that object resides in.
Sets the visibility of a specific paint representation. This allows for example to only show the PaintRepresentation.BODY of a layer and not the PaintRepresentation.LABEL:
var layer = ...;
layer.setPaintRepresentationVisible( PaintRepresentation.BODY, true );
layer.setPaintRepresentationVisible( PaintRepresentation.LABEL, false );
The renderer-type of the layer. Must be one of the supported paint representations.
the new visible state of the paint representation
Sets the visibility of a specific paint representation in a layer tree. If it set to true, this will ensure that the paint representation of every parent LayerTreeNode up to the roof of the tree is configured to be visible as well.
The renderer-type of the layer. Must be one of the supported paint representations.
the new visible state of the paint representation
Accepts the given visitor on the children of this
.
The visitor which will receive the callbacks for the children.
The order in which the children need to be traversed.
Wait until this layer or layer group is finished with all possible work related to any change that happened before this call.
At that moment, the screen is up-to-date with all changes.
map.mapNavigator.fit({ bounds: somewhere });
map.layerTree.whenReady().then(makeScreenshot);
or
layer.painter.invalidateAll();
layer.whenReady().then(alert);
or
layer.model.add(newFeature);
layer.whenReady().then(alert);
This call can be used to have a reliable, programmatic way to wait for all work leading up to the call to be reflected on the screen.
A promise that resolves to the LayerTreeNode when all current work is done
Registers a callback function for a given event type.
the event type to register on
the callback function to register
Rest
...args: any[]Optional
context: anythe context in which the callback function should be invoked implementation dependent.
a handle to the registered callback with a single function 'remove'. This function can be used to unregister the callback function.
Event fired when the editability of the layer changes.
the 'EditableChanged' changed event.
the callback to be invoked when the editability of the layer changes. The callback gets the 'editable' boolean parameter, which indicates whether or not the layer is editable.
Optional
context: anyvalue to use as this when executing callback
Base class for raster layers.