Class LayerTreeNodeAbstract

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

Hierarchy

Implements

Constructors

constructor

Accessors

children id label map parent supportedPaintRepresentations treeNodeType visible visibleInTree

Methods

accept findLayerById findLayerGroupById findLayerTreeNodeById isPaintRepresentationSupported isPaintRepresentationVisible isPaintRepresentationVisibleInTree setPaintRepresentationVisible setPaintRepresentationVisibleInTree visitChildren whenReady

Events

PaintRepresentationVisibilityChanged VisibilityChanged VisibilityInTreeChanged LabelChanged

Constructors

constructor

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

  • 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

  • set label(value): void

  • Parameters

    • value: string

    Returns void

map

  • get map(): null | Map

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

    Returns null | Map

parent

  • get parent(): null | LayerGroup

  • 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 null | LayerGroup

supportedPaintRepresentations

Abstract treeNodeType

visible

  • get visible(): 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 visibleInTree instead.

    Returns boolean

  • set visible(visible): void

  • Parameters

    • visible: boolean

    Returns void

visibleInTree

  • get visibleInTree(): 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.

    Returns boolean

  • set visibleInTree(value): void

  • Parameters

    • value: boolean

    Returns void

Methods

accept

findLayerById

  • 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

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

    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

    Since

    2014.0

findLayerTreeNodeById

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

    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

    Since

    2014.0

isPaintRepresentationSupported

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

    Parameters

    Returns boolean

    true when paintRepresentation is supported, false otherwise.

isPaintRepresentationVisible

  • Indicates whether the specified paint representation is visible.

    Parameters

    Returns boolean

    true when paintRepresentation is supported and visible, false otherwise

    See

    setPaintRepresentationVisible

isPaintRepresentationVisibleInTree

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

    Parameters

    Returns boolean

    true when paintRepresentation is supported and visible, false otherwise

    See

    setPaintRepresentationVisibleInTree

setPaintRepresentationVisible

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

    Parameters

    Returns void

setPaintRepresentationVisibleInTree

  • 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

    Returns void

visitChildren

  • 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

  • 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 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

Events

"" event

  • on("", callback: ((...args) => void), context?: any) : Handle

  • Registers a callback function for a given event type.

    Parameters

    • event: string

      the event type to register on

    • callback: ((...args) => void)

      the callback function to register

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

      the context in which the callback function should be invoked implementation dependent.

    Returns Handle

    a handle to the registered callback with a single function 'remove'. This function can be used to unregister the callback function.

"PaintRepresentationVisibilityChanged" event

  • on("PaintRepresentationVisibilityChanged", callBack: ((visibility, paintRepresentation) => void), context?: any) : Handle

  • Fired when the visibility of a certain paint representation of the layer changes. See setPaintRepresentationVisible.

    Parameters

    • event: "PaintRepresentationVisibilityChanged"

      the "PaintRepresentationVisibilityChanged" event.

    • callBack: ((visibility, 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, paintRepresentation): void

        • Parameters

          Returns void

    • Optional context: any

      value to use as this when executing callback.

    Returns Handle

"VisibilityChanged" event

  • on("VisibilityChanged", callBack: ((visibility) => void), context?: any) : Handle

  • Fired when the visibility property of the layer changes. See visible.

    Parameters

    • event: "VisibilityChanged"

      the "VisibilityChanged" event

    • callBack: ((visibility) => void)

      the callback to be invoked when the visibility property of the layer changes. The callback gets one parameter, 'visibility' which is the new visible property of the layer.

        • (visibility): void

        • Parameters

          • visibility: boolean

          Returns void

    • Optional context: any

      value to use as this when executing callback.

    Returns Handle

"VisibilityInTreeChanged" event

  • on("VisibilityInTreeChanged", callBack: ((visibleInTree) => void)) : Handle

  • Fired when the visibility of the layer on the map changes. See visibleInTree.

    Parameters

    • event: "VisibilityInTreeChanged"

      the "VisibilityInTreeChanged" event

    • callBack: ((visibleInTree) => void)

      the callback to be invoked when the visibility of the layer changes on the map. The callback gets one parameter, 'visibleInTree' which indicates whether the layer is visible on the map or not.

        • (visibleInTree): void

        • Parameters

          • visibleInTree: boolean

          Returns void

    Returns Handle

    Since

    2023.1

"LabelChanged" event

  • on("LabelChanged", callBack: ((label) => void), context?: any) : Handle

  • Fired when the label of the layer or layer group changes. See label.

    Parameters

    • event: "LabelChanged"

      the "LabelChanged" event

    • callBack: ((label) => 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): void

        • Parameters

          • label: string

          Returns void

    • Optional context: any

      value to use as this when executing callback.

    Returns Handle

Settings

Member Visibility

Theme