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 id(): string;
        get internal(): boolean;
        get isDestroyed(): boolean;
        get layers(): undefined;
        get legend(): string | undefined;
        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;
    }

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    attributes children description destroyed id internal isDestroyed layers legend map name nullableMap parent parentLayer sublayers title type visible

    Methods

    deleteAttribute destroy setDescription setInternal setTitle setVisible updateAttributes

    Accessors

    • get attributes(): Record<string | symbol, unknown>

      Additional attributes associated with this layer.

      NOTE: Do not modify vis this getter. Use updateAttributes or deleteAttribute instead.

      Returns Record<string | symbol, unknown>

    • 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 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 isDestroyed(): boolean

      True if the layer has been destroyed.

      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 nullableMap(): MapModel | undefined

      The map this layer belongs to, or undefined if the layer is not part of a map.

      Returns MapModel | undefined

    • get parent(): WMSLayer | WMSSublayer

      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 WMSLayer | WMSSublayer

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

    • get title(): string

      The human-readable title of this layer.

      Returns string

    • get type(): "wms-sublayer"

      Identifies the type of this layer.

      Returns "wms-sublayer"

    • 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

    Methods

    • Destroys the layer and everything owned by it.

      NOTE: Layers that are part of the map will be destroyed automatically when that map is being destroyed.

      Returns void

    • 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

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods