LayerTreeNode | LuciadRIA (2023.0.05)

A node in a LayerGroup. Can not be instantiated directly, use a more specific type of node instead.

Hierarchy

LayerTreeNode
- LayerGroup
- Layer

Implements

Evented

Overview

Enumerations

VisitOrder

Events

Accessors

Methods

Events

on

(event: string, callback: (...args: any[]) => void, context?: any): Handle
(event: "PaintRepresentationVisibilityChanged", callBack: (visibility: boolean, paintRepresentation: PaintRepresentation) => void, context?: any): Handle
(event: "VisibilityChanged", callBack: (visibility: boolean) => void, context?: any): Handle
(event: "LabelChanged", callBack: (label: string) => void, context?: any): Handle

Parameters
- event: string
- callback: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns Handle
Fired when the visibility of a certain paint representation of the layer changes. See setPaintRepresentationVisible.

Parameters
- event: "PaintRepresentationVisibilityChanged"
  
  the "PaintRepresentationVisibilityChanged" event.
- callBack: (visibility: boolean, paintRepresentation: PaintRepresentation) => void
  
  the callback to be invoked when the visibility of a certain paint representation of the layer changes. The callback gets two parameters, 'visibility' indicates whether or not the 'paintRepresentation' is visible.
  - - (visibility: boolean, paintRepresentation: PaintRepresentation): void
    - Parameters
      - visibility: boolean
      - paintRepresentation: PaintRepresentation
      Returns void
- Optional context: any
  
  value to use as this when executing callback.
Returns Handle
Fired when the visibility of the layer changes. See visible.

Parameters
- event: "VisibilityChanged"
  
  the "VisibilityChanged" event
- callBack: (visibility: boolean) => void
  
  the callback to be invoked when the visibility of the layer changes. The callback gets one parameter, 'visibility' which indicates whether the layer is visible or not.
  - - (visibility: boolean): void
    - Parameters
      - visibility: boolean
      Returns void
- Optional context: any
  
  value to use as this when executing callback.
Returns Handle
Fired when the label of the layer or layer group changes. See label.

Parameters
- event: "LabelChanged"
  
  the "LabelChanged" event
- callBack: (label: string) => void
  
  the callback to be invoked when the label of the layer or layer group changes. The callback gets one parameter. 'label' which is the new label of the layer.
  - - (label: string): void
    - Parameters
      - label: string
      Returns void
- Optional context: any
  
  value to use as this when executing callback.
Returns Handle

Accessors

children

get children(): LayerTreeNode[]

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.

Returns LayerTreeNode[]

id

get id(): string

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.

Returns string

label

get label(): string
set label(value: string): void

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.

Returns string
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.

Parameters
- value: string
Returns any

map

get map(): Map | null

The map this note is attached to, or null. This property will be null if this node is not attached to a map.

Returns Map | null

parent

get parent(): LayerGroup | null

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.

Returns LayerGroup | null

supportedPaintRepresentations

get supportedPaintRepresentations(): PaintRepresentation[]

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

Returns PaintRepresentation[]

treeNodeType

get treeNodeType(): LayerTreeNodeType

The LayerTreeNodeType of this node.

Returns LayerTreeNodeType

visible

get visible(): boolean
set visible(visible: boolean): void

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 LayerTreeNode.visibleInTree instead.

Returns boolean
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 LayerTreeNode.visibleInTree instead.

Parameters
- visible: boolean
Returns any

visibleInTree

get visibleInTree(): boolean
set visibleInTree(value: boolean): void

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 boolean
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.

Parameters
- value: boolean
Returns any

Methods

accept

(visitor: LayerTreeVisitor): ReturnValue

Accepts the given visitor on this LayerTreeNode.

Parameters
- visitor: LayerTreeVisitor
  
  The visitor instance that must be used to process this
Returns ReturnValue

either CONTINUE or ABORT

findLayerById

(id: string): Layer

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.

Parameters
- id: string
  
  The id of the layer that you want to retrieve.
Returns Layer

the requested layer or undefined if it is not present in the tree

findLayerGroupById

(id: string): LayerGroup

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

since

2014.0

Parameters
- id: string
  
  The id of the layer group that you want to retrieve.
Returns LayerGroup

the requested layer group or undefined if it is not present in the tree

findLayerTreeNodeById

(id: string): LayerTreeNode

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

Parameters
- id: string
  
  The id of the layerTreeNode that you want to retrieve.
Returns LayerTreeNode

the requested layerTreeNode or undefined if it is not present in the tree

isPaintRepresentationSupported

(paintRepresentation: PaintRepresentation): boolean

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 LABEL paint representation.

Parameters
- paintRepresentation: PaintRepresentation
  
  the paint representation
Returns boolean

true when paintRepresentation is supported, false otherwise.

isPaintRepresentationVisible

(paintRepresentation: PaintRepresentation): boolean

Indicates whether the specified paint representation is visible.

see

setPaintRepresentationVisible

Parameters
- paintRepresentation: PaintRepresentation
  
  The paint representation
Returns boolean

true when paintRepresentation is supported and visible, false otherwise

isPaintRepresentationVisibleInTree

(paintRepresentation: PaintRepresentation): boolean

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

Parameters
- paintRepresentation: PaintRepresentation
  
  The paint representation
Returns boolean

true when paintRepresentation is supported and visible, false otherwise

setPaintRepresentationVisible

(paintRepresentation: PaintRepresentation, visible: boolean): void

Sets the visibility of a specific paint representation. This allows for example to only show the BODY of a layer and not the LABEL:
```
  var layer = ...;
  layer.setPaintRepresentationVisible( PaintRepresentation.BODY, true );
  layer.setPaintRepresentationVisible( PaintRepresentation.LABEL, false );
```
Parameters
- paintRepresentation: PaintRepresentation
  
  The renderer-type of the layer. Must be one of the supported paint representations.
- visible: boolean
  
  the new visible state of the paint representation
Returns void

setPaintRepresentationVisibleInTree

(paintRepresentation: PaintRepresentation, visible: boolean): void

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.

Parameters
- paintRepresentation: PaintRepresentation
  
  The renderer-type of the layer. Must be one of the supported paint representations.
- visible: boolean
  
  the new visible state of the paint representation
Returns void

visitChildren

(visitor: LayerTreeVisitor, order: VisitOrder): void

Accepts the given visitor on the children of this.

Parameters
- visitor: LayerTreeVisitor
  
  The visitor which will receive the callbacks for the children.
- order: VisitOrder
  
  The order in which the children need to be traversed.
Returns void

whenReady

(): Promise<LayerTreeNode>

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);
```
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.
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 LayerGroup or LayerTree will wait until all its children are ready.
Returns Promise<LayerTreeNode>

A promise that resolves to the LayerTreeNode when all current work is done

Legend

Module
Object literal
Variable
Function
Function with type parameter
Index signature
Type alias
Type alias with type parameter

Enumeration
Enumeration member
Property
Method

Interface
Interface with type parameter
Constructor
Property
Method
Index signature

Class
Class with type parameter
Constructor
Property
Method
Accessor
Index signature

Inherited constructor
Inherited property
Inherited method
Inherited accessor

Protected property
Protected method
Protected accessor

Private property
Private method
Private accessor

Static property
Static method

Hierarchy

Implements

Overview

Enumerations

Events

Accessors

Methods

Events

on

Parameters

event: string

callback: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns Handle

Parameters

event: "PaintRepresentationVisibilityChanged"

callBack: (visibility: boolean, paintRepresentation: PaintRepresentation) => void

Parameters

visibility: boolean

paintRepresentation: PaintRepresentation

Returns void

Optional context: any

Returns Handle

Parameters

event: "VisibilityChanged"

callBack: (visibility: boolean) => void

Parameters

visibility: boolean

Returns void

Optional context: any

Returns Handle

Parameters

event: "LabelChanged"

callBack: (label: string) => void

Parameters

label: string

Returns void

Optional context: any

Returns Handle

Accessors

children

Returns LayerTreeNode[]

id

Returns string

label

Returns string

Parameters

value: string

Returns any

map

Returns Map | null

parent

Returns LayerGroup | null

supportedPaintRepresentations

Returns PaintRepresentation[]

treeNodeType

Returns LayerTreeNodeType

visible

Returns boolean

Parameters

visible: boolean

Returns any

visibleInTree

Returns boolean

Parameters

value: boolean

Returns any

Methods

accept

Parameters

visitor: LayerTreeVisitor

Returns ReturnValue

findLayerById

Parameters

id: string

Returns Layer

findLayerGroupById