@honua/sdk-js
    Preparing search index...

    Interface LocatorCompatOptions

    interface LocatorCompatOptions {
        apiKey?: string;
        capabilityPolicy?: CapabilityPolicy;
        eventBus?: CompatEventBus;
        extentPaddingDegrees?: number;
        maxLocations?: number;
        provider?: GeocodingProvider;
        requestOptions?: Record<string, unknown>;
        url?: string;
    }
    Index

    Properties

    apiKey? capabilityPolicy? eventBus? extentPaddingDegrees? maxLocations? provider? requestOptions? url?

    Properties

    apiKey?: string

    Accepted for ArcGIS constructor parity; diagnostics only (never sent).

    capabilityPolicy?: CapabilityPolicy

    Capability policy for provider capability misses; defaults to "strict".

    eventBus?: CompatEventBus
    extentPaddingDegrees?: number

    Half-width, in degrees, of the square extent derived around a candidate point when the provider surfaces no Xmin/Ymin/Xmax/Ymax attributes. Defaults to 0.01 (roughly a 2 km box at the equator).

    maxLocations?: number

    Default maxLocations when a call does not specify one.

    provider?: GeocodingProvider

    Geocoding provider every operation is executed against.

    requestOptions?: Record<string, unknown>

    Accepted for ArcGIS constructor parity; diagnostics only (never sent).

    url?: string

    Original ArcGIS GeocodeServer URL. Retained for diagnostics only — it is never fetched. Geocoding always runs through provider.

    Settings

    Member Visibility

    On This Page

    Properties