Georeferencing API
    Preparing search index...

    Interface CustomReference

    Host-defined cancellable reference loader; useful for services with custom paging, authentication or split geographic queries.

    interface CustomReference {
        id: string;
        kind: "custom";
        label: string;
        load: (
            query: Query,
        ) => Promise<
            {
                crs: string;
                data: FeatureCollection;
                message?: string;
                partial: boolean;
            },
        >;
        loading?: "fixed"
        | "viewport";
        queryBounds?: Extent;
        queryCrs: string;
        snapping?: SnapOptions;
    }

    Hierarchy (View Summary)

    Index
    id kind label load loading? queryBounds? queryCrs snapping?
    id: string

    Unique stable provider ID within an editor binding.

    kind: "custom"

    Discriminator for a custom reference loader.

    label: string

    Human-readable provider name for loading/error feedback.

    load: (
        query: Query,
    ) => Promise<
        {
            crs: string;
            data: FeatureCollection;
            message?: string;
            partial: boolean;
        },
    >

    Load a query and declare the returned coordinate CRS. The binding discards late results after a newer query or detach.

    loading?: "fixed" | "viewport"

    Viewport queries follow navigation; fixed queries use configured bounds.

    "viewport"

    queryBounds?: Extent

    Optional loading constraint in queryCrs. Required for fixed loading.

    queryCrs: string

    CRS in which the loader receives query bounds.

    snapping?: SnapOptions

    Opt into reference snapping and configure its tolerance.

    Settings
    Member Visibility

    On This Page
    Properties