Georeferencing API
    Preparing search index...

    Interface GeoreferencerProps

    Integration props for the ready-made editor. Keep controller, map and binding configuration stable across React renders.

    interface GeoreferencerProps {
        bindingOptions?: BindingOptions;
        className?: string;
        controller: GeoreferencerController;
        controls?: Partial<GeoreferencerControls>;
        emptyImageActions?: ReactNode;
        formatError?: (
            error: {
                code: string;
                message: string;
                operationId?: string;
                recoverable: boolean;
            },
        ) => string;
        onExport?: (result: ExportResult) => void | Promise<void>;
        propertyEditor?: (
            feature: Feature<Point | LineString | Polygon, Record<string, unknown>>,
            update: (properties: Record<string, unknown>) => void,
        ) => ReactNode;
        referenceMap: Map;
        referenceView?: ReactNode;
        t?: Translate;
    }
    Index
    bindingOptions? className? controller controls? emptyImageActions? formatError? onExport? propertyEditor? referenceMap referenceView? t?
    bindingOptions?: BindingOptions

    Reference providers, projections, snapping and optional initial map framing. Memoize this object to avoid reattachment.

    className?: string

    Additional class on the editor root; built-in styles are scoped beneath rg-prefixed classes.

    controller: GeoreferencerController

    Host-owned authoritative controller; the component resumes/suspends it but does not permanently dispose it.

    controls?: Partial<GeoreferencerControls>

    Optional controls of the guided layout. Omitted flags use MINIMAL_CONTROLS; pass ALL_CONTROLS for every expert control. The classic layout always shows all controls.

    emptyImageActions?: ReactNode

    Extra actions shown in the empty image drop zone next to "Choose image", for example a button that loads a sample image.

    formatError?: (
        error: {
            code: string;
            message: string;
            operationId?: string;
            recoverable: boolean;
        },
    ) => string

    Optional structured-error formatter, allowing localization by error code instead of parsing English strings.

    onExport?: (result: ExportResult) => void | Promise<void>

    Receive any configured format's revisioned artifacts instead of default downloads.

    propertyEditor?: (
        feature: Feature<Point | LineString | Polygon, Record<string, unknown>>,
        update: (properties: Record<string, unknown>) => void,
    ) => ReactNode

    Render a host-specific property form. Call the provided update callback with a replacement JSON properties object; do not mutate the frozen feature.

    referenceMap: Map

    Existing host-owned OpenLayers map. The component attaches owned layers/interactions and leaves the map alive on unmount.

    referenceView?: ReactNode

    Opt into the guided four-step layout (load, match, check, export/draw) by supplying the host map's rendered target and controls. The host still creates, targets and disposes the map. This slot stays mounted across all steps and responsive image/map tabs.

    t?: Translate

    Translation function for default English messages; identity when omitted.

    Settings
    Member Visibility

    On This Page
    Properties