Open Pioneer Trails Packages
    Preparing search index...

    Interface LayerConfig

    Configuration options supported by all operational layer types.

    interface LayerConfig {
        attributes?: Record<string | symbol, unknown>;
        description?: string;
        healthCheck?: string | HealthCheckFunction;
        id?: string;
        isBaseLayer?: boolean;
        title: string;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes? description? healthCheck? id? isBaseLayer? 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.

    healthCheck?: string | HealthCheckFunction

    Optional property to check the availability of the layer. It is possible to provide either a URL which indicates the state of the service (2xx response meaning "ok") or a HealthCheckFunction performing a custom check and returning the state.

    id?: string

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

    isBaseLayer?: boolean

    Whether this layer is a base layer or not. Only one base layer can be active at a time.

    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