Open Pioneer Trails Packages
    Preparing search index...

    Interface GroupLayerConfig

    Configuration options to construct a GroupLayer.

    interface GroupLayerConfig {
        attributes?: Record<string | symbol, unknown>;
        description?: string;
        healthCheck?: string | HealthCheckFunction;
        id?: string;
        internal?: boolean;
        isBaseLayer?: boolean;
        layers: Layer[];
        maxResolution?: number;
        maxZoom?: number;
        minResolution?: number;
        minZoom?: number;
        title: string;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes? description? healthCheck? id? internal? isBaseLayer? layers maxResolution? maxZoom? minResolution? minZoom? 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.

    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

    isBaseLayer?: boolean

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

    Defaults to false.

    layers: Layer[]

    List of layers that belong to the new group layer.

    The group layer takes ownership of the given layers: they will be destroyed when the parent is destroyed. A layer must have a unique parent: it can only be added to the map or a single group layer.

    maxResolution?: number

    Optional property to restrict the visibility of a layer to a maximum resolution (exclusive).

    maxZoom?: number

    Optional property to restrict the visibility of a layer to a maximum zoom level (exclusive).

    minResolution?: number

    Optional property to restrict the visibility of a layer to a minimum resolution (inclusive).

    minZoom?: number

    Optional property to restrict the visibility of a layer to a minimum zoom level (inclusive).

    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