TomTom Maps SDK for JavaScript
This is the documentation of version 0.56.0. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ReverseGeocodingOptionalParams

    Optional parameters for customizing reverse geocoding requests.

    These parameters allow fine-tuning of the reverse geocoding behavior, including filtering, formatting, and additional data retrieval.

    type ReverseGeocodingOptionalParams = {
        geographyType?: GeographyType[];
        heading?: number;
        radiusMeters?: number;
        view?: View;
    }
    Index
    geographyType? heading? radiusMeters? view?
    geographyType?: GeographyType[]

    Filters results to specific geography entity types.

    Narrows the search to specified geography types (e.g., country, state, city).

    Note: When set, heading is ignored.

    heading?: number

    Directional heading of the vehicle in degrees.

    Specifies the travel direction along a road segment to provide direction-aware address information. Ignored when geographyType is set.

    • 0 = North
    • 90 = East
    • 180 = South
    • 270 = West
    heading: 90.5  // Traveling east-northeast

    -360

    360

    radiusMeters?: number

    Search radius in meters from the specified position.

    Limits the search area using the provided coordinates as the center point. Must be a positive integer value.

    1

    view?: View

    Specifies the geopolitical view for the results.

    Determines how disputed territories and borders are represented in the response.

    Available views:

    • Unified - International view (default)
    • AR - Argentina
    • CN - China
    • IL - Israel
    • IN - India
    • MA - Morocco
    • PK - Pakistan
    • RS - Serbia
    • RU - Russia
    • TR - Turkey
    • TW - Taiwan

    MA is accepted by this type but is not supported by the current backend.

    "Unified"

    Settings
    Member Visibility

    On This Page
    Properties