Open Pioneer Trails Packages
    Preparing search index...

    Interface WMSLayerConfig

    Configuration options to construct a WMS layer.

    interface WMSLayerConfig {
        attributes?: Record<string | symbol, unknown>;
        description?: string;
        fetchCapabilities?: boolean;
        healthCheck?: string | HealthCheckFunction;
        id?: string;
        isBaseLayer?: boolean;
        sourceOptions?: Partial<Options>;
        sublayers?: WMSSublayerConfig[];
        title: string;
        url: string;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes? description? fetchCapabilities? healthCheck? id? isBaseLayer? sourceOptions? sublayers? title url 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.

    fetchCapabilities?: boolean

    Whether to automatically fetch capabilities from the service when needed (default: true).

    Setting this to false can be useful as a performance optimization when capabilities are not really required by the application. Note that this will disable some features of the WMS layer: for example, the legend URL will not be available.

    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.

    sourceOptions?: Partial<Options>

    Additional source options for the layer's WMS source.

    NOTE: These options are intended for advanced configuration: the WMS Layer manages some of the OpenLayers source options itself.

    sublayers?: WMSSublayerConfig[]

    Configures the layer's sublayers.

    title: string

    The human-readable title of this layer.

    url: string

    URL of the WMS service.

    visible?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties