Interface WmsFeatureInfoRequest

WMS 1.3 GetFeatureInfo request envelope.

interface WmsFeatureInfoRequest {
    bbox: readonly [number, number, number, number];
    bgcolor?: string;
    crs?: WmsCrs;
    elevation?: string;
    extraParams?: Record<string, string | number | boolean>;
    featureCount?: number;
    format?: string;
    height: number;
    i: number;
    infoFormat?:
        | "application/json"
        | string & {}
        | "text/plain"
        | "text/html";
    j: number;
    layers: readonly string[];
    queryLayers: readonly string[];
    signal?: AbortSignal;
    styles?: readonly string[];
    time?: string;
    transparent?: boolean;
    width: number;
}

Hierarchy (view full)

Properties

bbox bgcolor? crs? elevation? extraParams? featureCount? format? height i infoFormat? j layers queryLayers signal? styles? time? transparent? width

Properties

bbox

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.

Optionalbgcolor

bgcolor?: string

Background colour as 0xRRGGBB or #RRGGBB.

Optionalcrs

crs?: WmsCrs

CRS code. Defaults to EPSG:3857.

Optionalelevation

elevation?: string

WMS ELEVATION dimension override.

OptionalextraParams

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

Vendor extras forwarded verbatim on the wire.

OptionalfeatureCount

featureCount?: number

Maximum features to return.

Optionalformat

format?: string

Image MIME type. Defaults to image/png.

height

height: number

i

i: number

Pixel column offset within the rendered image.

OptionalinfoFormat

infoFormat?:
    | "application/json"
    | string & {}
    | "text/plain"
    | "text/html"

INFO_FORMAT MIME type. Defaults to application/json.

j

j: number

Pixel row offset within the rendered image.

layers

layers: readonly string[]

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

queryLayers

queryLayers: readonly string[]

Layers to query. Subset of layers.

Optionalsignal

signal?: AbortSignal

Optionalstyles

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.

Optionaltime

time?: string

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

Optionaltransparent

transparent?: boolean

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

width

width: number

Settings

Member Visibility

On This Page

Properties