@honua/sdk-js
    Preparing search index...

    Interface WmsMapRequest

    WMS 1.3 GetMap request envelope.

    interface WmsMapRequest {
        bbox: readonly [number, number, number, number];
        bgcolor?: string;
        crs?: WmsCrs;
        elevation?: string;
        extraParams?: Record<string, string | number | boolean>;
        format?: string;
        height: number;
        layers: readonly string[];
        signal?: AbortSignal;
        styles?: readonly string[];
        time?: string;
        transparent?: boolean;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bbox bgcolor? crs? elevation? extraParams? format? height layers signal? styles? time? transparent? width

    Properties

    bbox: readonly [number, number, number, number]

    Bounding box in the requested CRS. Tuple is the canonical [minx, miny, maxx, maxy] shape; the adapter swaps axis order when the CRS is EPSG:4326 (lat,lon) per WMS 1.3 §6.7.3.2.

    bgcolor?: string

    Background colour as 0xRRGGBB or #RRGGBB.

    crs?: WmsCrs

    CRS code. Defaults to EPSG:3857.

    elevation?: string

    WMS ELEVATION dimension override.

    extraParams?: Record<string, string | number | boolean>

    Vendor extras forwarded verbatim on the wire.

    format?: string

    Image MIME type. Defaults to image/png.

    height: number
    layers: readonly string[]

    Layer names. Multiple layers are serialized as a comma-separated LAYERS= value.

    signal?: AbortSignal
    styles?: readonly string[]

    Style names. When present the array length must match layers. An empty array (or a missing entry) selects the layer's default style.

    time?: string

    WMS TIME dimension override; falls back to the layer default.

    transparent?: boolean

    Whether the rendered image should be transparent. Defaults to true.

    width: number

    Settings

    Member Visibility

    On This Page

    Properties