Open Pioneer Trails Packages
    Preparing search index...

    Interface WMSSublayer

    Represents a sublayer of a WMSLayer.

    interface WMSSublayer {
        get attributes(): Record<string | symbol, unknown>;
        get children(): ChildrenCollection<AnyLayer> | undefined;
        deleteAttribute(deleteAttribute: string | symbol): void;
        get description(): string;
        destroy(): void;
        get destroyed(): EventSource<void>;
        get effectivelyVisible(): boolean;
        get id(): string;
        get internal(): boolean;
        get isDestroyed(): boolean;
        get layers(): undefined;
        get legend(): string | undefined;
        get loadError(): Error | undefined;
        get loadState(): LayerLoadState;
        get map(): MapModel;
        get name(): string | undefined;
        get nullableMap(): MapModel | undefined;
        get parent(): WMSLayer | WMSSublayer;
        get parentLayer(): WMSLayer;
        setDescription(newDescription: string): void;
        setInternal(newIsInternal: boolean): void;
        setTitle(newTitle: string): void;
        setVisible(newVisibility: boolean): void;
        get sublayers(): SublayersCollection<WMSSublayer>;
        get title(): string;
        get type(): "wms-sublayer";
        updateAttributes(newAttributes: Record<string | symbol, unknown>): void;
        get visible(): boolean;
        get visibleInHierarchy(): boolean;
    }

    Hierarchy (View Summary)

    Implements

    Index
    • get description(): string

      The human-readable description of this layer. May be empty.

      Returns string

    • get destroyed(): EventSource<void>

      Emits an event when the layer is destroyed.

      Returns EventSource<void>

    • get effectivelyVisible(): boolean

      Returns true if this layer is effectively visible.

      A layer is effectively visible if nothing prevents it from being rendered on the map:

      • the layer and all its parents are visible (see also visibleInHierarchy),
      • no further conditions of the specific layer types prevents the layer or its parents from being rendered. For example, operational layers are only effectively visible if they are visible in the current map scale.

      Use this property to test whether a layer is currently displayed on the map.

      Returns boolean

    • 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 component (e.g. Toc or Legend). The internal state is independent of the layer's visibility which is determined by visible.

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

      Returns boolean

    • get layers(): undefined

      If this layer is a group layer this property contains a collection of all layers that are members of the group.

      The property shall be undefined if it is not a group layer.

      The properties layers and sublayers are mutually exclusive.

      Returns undefined

    • get legend(): string | 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 string | undefined

    • get name(): string | undefined

      The name of the WMS sublayer in the service's capabilities.

      Is optional as a WMS group layer in a WMS service does not need to have a name.

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

    • get visibleInHierarchy(): boolean

      Returns true if this layer is visible within its layer hierarchy.

      A layer is visible in its hierarchy if it is visible and all its parents are visible as well. In other words, a layer is not visible in its hierarchy as soon as any of its parent layers are invisible.

      See also effectivelyVisible.

      Returns boolean

    • Updates the attributes of this layer. Values in newAttributes will override existing values with the same key.

      Parameters

      • newAttributes: Record<string | symbol, unknown>

      Returns void