Georeferencing API
    Preparing search index...

    Interface WfsReference

    Explicit read-only WFS provider configuration. Request and response axis order are independent; bounds constrain queries without georeferencing the image.

    interface WfsReference {
        axisOrder: "xy" | "yx";
        capabilities?: WfsCapabilities;
        id: string;
        idProperty?: string;
        kind: "wfs";
        label: string;
        loading?: "fixed" | "viewport";
        maxFeatures?: number;
        maxPages?: number;
        maxResolution?: number;
        maxResponseBytes?: number;
        outputFormat?: string;
        pageSize?: number;
        parameters?: Record<string, string>;
        queryBounds?: { crs: string; extent: Extent };
        request?: (url: string, init: RequestInit) => Promise<Response>;
        requestCrs: string;
        responseAxisOrder?: "xy" | "yx";
        responseCrs?: string;
        responseFormat: "geojson" | "gml";
        snapping?: SnapOptions;
        supportsStartIndex?: boolean;
        typeNames: string[];
        url: string;
        version: "2.0.0" | "1.1.0";
    }

    Hierarchy (View Summary)

    Index
    axisOrder capabilities? id idProperty? kind label loading? maxFeatures? maxPages? maxResolution? maxResponseBytes? outputFormat? pageSize? parameters? queryBounds? request? requestCrs responseAxisOrder? responseCrs? responseFormat snapping? supportsStartIndex? typeNames url version
    axisOrder: "xy" | "yx"

    Explicit BBOX wire order; xy uses minX,minY,maxX,maxY and yx swaps each pair.

    capabilities?: WfsCapabilities

    Optional pre-fetched discovery metadata used to validate version, feature types, formats and paging.

    id: string

    Unique stable provider ID within an editor binding.

    idProperty?: string

    Feature property used when the service omits a feature ID. Missing IDs are errors; duplicate IDs are deduplicated.

    kind: "wfs"

    Discriminator for a WFS reference provider.

    label: string

    Human-readable provider name for loading/error feedback.

    loading?: "fixed" | "viewport"

    Follow viewport navigation or repeatedly query the configured fixed bounds.

    "viewport"

    maxFeatures?: number

    Maximum retained unique features per query; exhaustion is reported as partial.

    5000

    maxPages?: number

    Page-request budget per query; exhaustion is reported as partial.

    20

    maxResolution?: number

    Skip loading when host map resolution exceeds this value, in map units per pixel; returns zoom-in feedback.

    maxResponseBytes?: number

    Maximum bytes streamed for each service response before parsing.

    20971520 (20 MiB)

    outputFormat?: string

    Exact service-advertised format string. Defaults to application/json or version-appropriate GML.

    pageSize?: number

    Requested features per page.

    500

    parameters?: Record<string, string>

    Additional query parameters, such as a read filter. Computed type names, BBOX and page counts take precedence.

    queryBounds?: { crs: string; extent: Extent }

    Optional spatial query constraint, transformed to requestCrs before viewport intersection.

    Type Declaration

    • crs: string

      CRS of the provider query boundary.

    • extent: Extent

      Provider query boundary in its declared CRS.

    request?: (url: string, init: RequestInit) => Promise<Response>

    Host fetch adapter for authentication/headers/credentials. Preserve init.signal to support cancellation.

    Native fetch
    requestCrs: string

    CRS of request bounds and the requested output coordinates.

    responseAxisOrder?: "xy" | "yx"

    Optional response axis override. GeoJSON defaults to xy; GML uses declared CRS/native OpenLayers axis conventions.

    responseCrs?: string

    Override incorrect/missing service CRS metadata. Otherwise the response declaration is preferred, then requestCrs.

    responseFormat: "geojson" | "gml"

    Response parser family; must agree with the service outputFormat.

    snapping?: SnapOptions

    Opt into reference snapping and configure its tolerance.

    supportsStartIndex?: boolean

    Explicit paging support for WFS 1.1 services; otherwise capabilities.paging is used. WFS 2 requests include startIndex.

    typeNames: string[]

    Qualified feature-type names to request.

    url: string

    GetCapabilities/GetFeature service URL. Use request injection for credentials rather than hardcoding secrets.

    version: "2.0.0" | "1.1.0"

    WFS protocol version; supported values are 1.1.0 and 2.0.0.

    Settings
    Member Visibility

    On This Page
    Properties