Open Pioneer Trails Packages
    Preparing search index...

    Interface LayerBaseTypeAbstract

    Represents an operational layer in the map.

    These layers always have an associated OpenLayers layer.

    Instances of this interface cannot be constructed directly; use a real layer class such as SimpleLayer instead.

    interface LayerBaseType {
        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 isBaseLayer(): boolean;
        get isDestroyed(): boolean;
        get layers(): GroupLayerCollection | undefined;
        get legend(): string | undefined;
        get loadState(): LayerLoadState;
        get map(): MapModel;
        get maxResolution(): number;
        get maxZoom(): number;
        get minResolution(): number;
        get minZoom(): number;
        get nullableMap(): MapModel | undefined;
        get olLayer(): BaseLayer;
        get parent(): AnyLayer | undefined;
        setDescription(newDescription: string): void;
        setInternal(newIsInternal: boolean): void;
        setMaxResolution(value: number): void;
        setMaxZoom(value: number): void;
        setMinResolution(value: number): void;
        setMinZoom(value: number): void;
        setTitle(newTitle: string): void;
        setVisible(newVisibility: boolean): void;
        get sublayers(): SublayersCollection<WMSSublayer> | undefined;
        get title(): string;
        type: LayerTypes;
        updateAttributes(newAttributes: Record<string | symbol, unknown>): void;
        get visible(): boolean;
        get visibleInScale(): boolean;
    }

    Hierarchy (View Summary)

    Index

    Accessors

    attributes children description destroyed id internal isBaseLayer isDestroyed layers legend loadState map maxResolution maxZoom minResolution minZoom nullableMap olLayer parent sublayers title visible visibleInScale

    Methods

    deleteAttribute destroy setDescription setInternal setMaxResolution setMaxZoom setMinResolution setMinZoom setTitle setVisible updateAttributes

    Properties

    type

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

      True if this layer is a base layer.

      Only one base layer can be visible at a time.

      Returns boolean

    • get isDestroyed(): boolean

      True if the layer has been destroyed.

      Returns boolean

    • get layers(): GroupLayerCollection | 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 GroupLayerCollection | 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 maxResolution(): number

      The maximum resolution (exclusive) below which this layer will be visible.

      Returns number

    • get maxZoom(): number

      The maximum view zoom level (inclusive) at which this layer will be visible.

      Returns number

    • get minResolution(): number

      The minimum resolution (inclusive) at which this layer will be visible.

      Returns number

    • get minZoom(): number

      The minimum view zoom level (exclusive) above which this layer will be visible.

      Returns number

    • 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(): SublayersCollection<WMSSublayer> | 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 SublayersCollection<WMSSublayer> | 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 visibleInScale(): boolean

      Whether the layer is visible in the current map scale or not.

      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

    • The maximum resolution (exclusive) below which this layer will be visible.

      Parameters

      • value: number

      Returns void

    • The maximum view zoom level (inclusive) at which this layer will be visible.

      Parameters

      • value: number

      Returns void

    • The minimum resolution (inclusive) at which this layer will be visible.

      Parameters

      • value: number

      Returns void

    • The minimum view zoom level (exclusive) above which this layer will be visible.

      Parameters

      • value: number

      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

    Properties

    type: LayerTypes

    Identifies the type of this layer.

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Properties