Georeferencing API
    Preparing search index...

    Interface WmsProviderOptions

    Host-owned WMS transport, decoding and bounded reference acquisition policy.

    interface WmsProviderOptions {
        axisOrder?: "xy" | "yx";
        decode: (blob: Blob) => Promise<PixelImage>;
        maxPixels?: number;
        maxTileSize?: number;
        parameters?: Record<string, string>;
        request?: (url: string, signal?: AbortSignal) => Promise<Blob>;
        source: ReferenceSource;
        url: string;
        version?: "1.1.1" | "1.3.0";
    }
    Index
    axisOrder? decode maxPixels? maxTileSize? parameters? request? source url version?
    axisOrder?: "xy" | "yx"

    BBOX wire order; defaults to yx for WMS 1.3.0 EPSG:4326, otherwise xy.

    decode: (blob: Blob) => Promise<PixelImage>

    Decode a tile into RGBA with the requested dimensions; supply your own decoder in Node.

    maxPixels?: number

    Maximum acquired raster area before requests start; defaults to 32 million pixels.

    maxTileSize?: number

    Maximum tile edge in pixels, integer 1–4096; defaults to 1024.

    parameters?: Record<string, string>

    Source filters/time/vendor parameters. GetMap geometry and selected layers override conflicts.

    request?: (url: string, signal?: AbortSignal) => Promise<Blob>

    Fetch a tile with host authentication/cancellation; defaults to fetch with the supplied signal.

    source: ReferenceSource

    Opaque source identity, content revision and configured layer/style ordering.

    url: string

    Endpoint remains host-private; no URL or credentials enter snapshot provenance.

    version?: "1.1.1" | "1.3.0"

    WMS protocol version; defaults to 1.3.0.

    Settings
    Member Visibility

    On This Page
    Properties