Open Pioneer Trails Packages
    Preparing search index...

    Represents a group of layers.

    A group layer contains a collection of Layer children. Groups can be nested to form a hierarchy.

    Hierarchy (View Summary)

    Index

    Accessors

    • get id(): string

      The unique id of this layer within its map model.

      NOTE: layer ids may not be globally unique: layers that belong to different map models may have the same id.

      Returns string

    • get internal(): boolean

      Property that specifies if the layer is an "internal" layer. Internal layers are not considered by any UI widget (e.g. Toc or Legend). The internal state is independent of the layer's visibility which is determined by visible

      NOTE: Some UI widgets might use component specific attributes or props that have precedence over the internal property.

      Returns boolean

    • get legend(): undefined

      Legend URL from the service capabilities, if available.

      Note: this property may be expanded upon in the future, e.g. to support more variants than just image URLs.

      Returns undefined

    • get olLayer(): LayerGroup

      Raw OpenLayers group instance.

      Warning: Do not manipulate the collection of layers in this group directly, changes are not synchronized!

      Returns LayerGroup

    • get parent(): AnyLayer | undefined

      The direct parent of this layer instance, used for sublayers or for layers in a group layer.

      The property shall be undefined if the layer is not a sublayer or member of a group layer.

      Returns AnyLayer | undefined

    • get sublayers(): undefined

      The collection of child sublayers for this layer. Sublayers are layers that cannot exist without an appropriate parent layer.

      Layers that can never have any sublayers may not have a sublayers collection.

      The properties layers and sublayers are mutually exclusive.

      Returns undefined

    • get visible(): boolean

      Whether the layer is visible or not.

      NOTE: The model's visible state may do more than influence the raw OpenLayers's visibility property. Future versions may completely remove invisible layers from the OpenLayer's map under some circumstances.

      Returns boolean

    Constructors

    Methods