Open Pioneer Trails Packages
    Preparing search index...

    Interface WMTSLayer

    Represents an operational layer in the map.

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

    interface WMTSLayer {
        attributes: Readonly<Record<string | symbol, unknown>>;
        children: undefined | ChildrenCollection<AnyLayer>;
        description: string;
        id: string;
        isBaseLayer: boolean;
        layers: undefined;
        legend: undefined | string;
        loadState: LayerLoadState;
        map: MapModel;
        matrixSet: string;
        name: string;
        olLayer: BaseLayer;
        parent: undefined | AnyLayer;
        sublayers: undefined | SublayersCollection<WMSSublayer>;
        title: string;
        type: "wmts";
        url: string;
        visible: boolean;
        deleteAttribute(deleteAttribute: string | symbol): void;
        setDescription(newDescription: string): void;
        setTitle(newTitle: string): void;
        setVisible(newVisibility: boolean): void;
        updateAttributes(newAttributes: Record<string | symbol, unknown>): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes children description id isBaseLayer layers legend loadState map matrixSet name olLayer parent sublayers title type url visible

    Methods

    deleteAttribute setDescription setTitle setVisible updateAttributes

    Properties

    attributes: Readonly<Record<string | symbol, unknown>>

    Additional attributes associated with this layer.

    children: undefined | ChildrenCollection<AnyLayer>

    The direct children of this layer.

    The children may either be a set of operational layers (e.g. for a group layer) or a set of sublayers, or undefined.

    See also layers and sublayers.

    description: string

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

    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.

    isBaseLayer: boolean

    True if this layer is a base layer.

    Only one base layer can be visible at a time.

    layers: undefined

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

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

    The properties layers and sublayers are mutually exclusive.

    legend: undefined | string

    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.

    loadState: LayerLoadState

    The load state of a layer.

    map: MapModel

    The map this layer belongs to.

    matrixSet: string

    The name of the tile matrix set in the service's capabilities.

    name: string

    The name of the WMTS layer in the service's capabilities.

    olLayer: BaseLayer

    The raw OpenLayers layer.

    parent: undefined | AnyLayer

    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.

    sublayers: undefined | SublayersCollection<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.

    title: string

    The human-readable title of this layer.

    type: "wmts"

    Identifies the type of this layer.

    url: string

    URL of the WMTS service.

    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.

    Methods

    • Updates the attributes of this layer. Values in newAttributes are merged into the existing ones (i.e. via Object.assign).

      Parameters

      • newAttributes: Record<string | symbol, unknown>

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods