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

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

    Properties

    type: LayerTypes

    Identifies the type of this layer.