Interface OgcMapImageRequest

Request envelope for an OGC API Maps render. collectionId is omitted for dataset-level renders. styleId selects a server-managed style; inline style overrides are not exposed here (the server-side spec does not standardize an inline-style channel).

interface OgcMapImageRequest {
    basePath?: string;
    bbox?: string | readonly [number, number, number, number];
    bboxCrs?: string;
    collectionId?: string | number;
    collections?: readonly string[];
    crs?: string;
    extraParams?: Record<string, string | number | boolean>;
    format?: OgcMapFormat;
    height?: number;
    signal?: AbortSignal;
    styleId?: string;
    transparent?: boolean;
    width?: number;
}

Properties

basePath? bbox? bboxCrs? collectionId? collections? crs? extraParams? format? height? signal? styleId? transparent? width?

Properties

OptionalbasePath

basePath?: string

Raw endpoint path prefix (defaults to the Honua facade /ogc/maps). A raw third-party OGC API Maps service root discovered by connect() threads its service-root path here so the render route resolves against the advertised layout instead of the facade.

Optionalbbox

bbox?: string | readonly [number, number, number, number]

OptionalbboxCrs

bboxCrs?: string

OptionalcollectionId

collectionId?: string | number

Optionalcollections

collections?: readonly string[]

Optional comma-separated list of collections (dataset-level only).

Optionalcrs

crs?: string

OptionalextraParams

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

Optionalformat

format?: OgcMapFormat

Optionalheight

height?: number

Optionalsignal

signal?: AbortSignal

OptionalstyleId

styleId?: string

Optionaltransparent

transparent?: boolean

Optional transparency hint.

Optionalwidth

width?: number

Settings

Member Visibility

On This Page

Properties