Class LayerTree

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.

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 map this note is attached to, or null. This property will be null if this node is not attached to a map.

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.

Denotes what PaintRepresentations are available for this layer. This usually depends on the type of layer or the painter configuration on the layer

The LayerTreeNodeType of this layer. The value is LAYER_GROUP.

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.

Accepts the given visitor on this LayerTreeNode.

Add a node to the LayerGroup

Verifies whether the node can be added at the specified position. This check does not modify the LayerGroup. This check takes into account the ID uniqueness and the ordering rules for layers that are applicable to the entire LayerTree. Layers of type LayerType.BASE must always be positioned at the bottom of the LayerTree.

Verifies whether the node can be moved to the specified position. This check does not modify the LayerGroup. This check takes into account the ordering rules for layers that are applicable to the entire LayerTree. Layers of type LayerType.BASE must always be positioned at the bottom of the LayerTree.

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.

Returns the layer group with the given ID if that layer is this node or one of its children.

Since

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.

Since

2014.0

Indicates whether the specified paint representation is supported for this layer. It returns always true since a LayerGroup is a collection of LayerTreeNodes. In other words, a group can support all the possible paint representations of its children.

Indicates whether the specified paint representation is visible.

See

setPaintRepresentationVisible

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.

See

setPaintRepresentationVisibleInTree

Move a node that belongs to the same map to another location in its layer tree.

Removes all children from the layer group.

Removes a child from this node.

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 );
Copy

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.

Accepts the given visitor on the children of this.

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.

Examples:

  map.mapNavigator.fit({ bounds: somewhere });
  map.layerTree.whenReady().then(makeScreenshot);
Copy

or

    layer.painter.invalidateAll();
    layer.whenReady().then(alert);
Copy

or

    layer.model.add(newFeature);
    layer.whenReady().then(alert);
Copy

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.
The returned promise will always resolve once, when the layer is ready. The promise is rejected when the layer does not become ready in 5 minutes.

Examples (not exhaustive) of aspects this promise will wait for:

• While loading image data when it displayed for the first time, or after navigating the view
• While loading image data after changing raster model properties such as WMS style
• While loading feature data when it displayed for the first time, enters its scale range, or after navigating the view
• While loading feature data after invalidating the layer query provider
• While processing features after invalidating the layer feature painter or shape provider, or changing the layer filter
• While processing features after they were added, updated or removed to/in/from a model or workingSet

NOTE: The promise gets resolved also when an error (QueryStatus.QUERY_ERROR) occurs while handling underlying query or when the node is invisible.

A LayerTree will wait until all its children are ready.