GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface OgcApiConfig

    OGC API Features source configuration. Set on a layer's data.ogcApi property to load features from an OGC API Features endpoint instead of a static file or URL.

    interface OgcApiConfig {
        url: string;
        collectionId?: string;
        bbox?: [number, number, number, number];
        maxFeatures?: number;
        limit?: number;
        autoRefresh?: boolean;
        autoRefreshDebounce?: number;
        headers?: Record<string, string>;
    }
    Index

    Properties

    url collectionId? bbox? maxFeatures? limit? autoRefresh? autoRefreshDebounce? headers?

    Properties

    url: string

    Base endpoint URL of the OGC API Features service. The collection path may be included here (e.g. https://api.example.com/collections/roads/items) or separated via collectionId.

    collectionId?: string

    OGC API Features collection identifier. When provided, appended to url as /collections/{collectionId}/items. Ignored when url already contains the full items path.

    bbox?: [number, number, number, number]

    Bounding box filter applied to each request. Format: [minLon, minLat, maxLon, maxLat] (WGS-84). When autoRefresh is enabled the current map viewport bbox is used instead.

    maxFeatures?: number

    Maximum total number of features to accumulate across all pages. Acts as a memory anti-DoS safeguard.

    10000
    limit?: number

    Number of features requested per page (limit query parameter).

    1000
    autoRefresh?: boolean

    When true, re-fetches features on every moveend map event so that the displayed data tracks the current viewport. Requires bbox support from the server.

    false
    autoRefreshDebounce?: number

    Debounce delay in milliseconds applied to moveend refreshes.

    300
    headers?: Record<string, string>

    Additional HTTP request headers (e.g. Authorization: Bearer …).

    Settings

    Member Visibility

    On This Page

    Properties