Open Pioneer Trails Packages
    Preparing search index...

    Interface LayerBaseConfig

    Configuration options supported by all layer types (layers and sublayers).

    interface LayerBaseConfig {
        attributes?: Record<string | symbol, unknown>;
        description?: string;
        id?: string;
        internal?: boolean;
        title: string;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes? description? id? internal? title visible?

    Properties

    attributes?: Record<string | symbol, unknown>

    Additional attributes for this layer. These can be arbitrary values.

    description?: string

    The human-readable description of this layer. Defaults to an empty string.

    id?: string

    The unique id of this layer. Defaults to a generated id.

    internal?: boolean

    Layers marked as internal are not considered by any UI widget (e.g. Toc or Legend). By default, layers are not included when retrieving all layers of a collection (see LayerRetrievalOptions.includeInternalLayers).

    Defaults to false

    title: string

    The human-readable title of this layer.

    visible?: boolean

    Whether this layer should initially be visible. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties