TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.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.

    They fine-tune the reverse geocoding behaviour, including filtering, formatting and additional data retrieval.

    type ReverseGeocodingOptionalParams = {
        geographyTypes?: GeographyType[];
        geopoliticalView?: GeopoliticalView;
        heading?: number;
        radiusMeters?: number;
    }
    Index
    geographyTypes? geopoliticalView? heading? radiusMeters?
    geographyTypes?: GeographyType[]

    Geography entity types to filter results to.

    It narrows the search to these geography types (e.g., country, state, city).

    When you set it, heading is ignored.

    geopoliticalView?: GeopoliticalView

    Geopolitical view of the result, overriding the global one. It sets which country an address in a disputed territory belongs to. See GeopoliticalView.

    heading?: number

    Directional heading of the vehicle in degrees.

    The travel direction along a road segment, for direction-aware address information. It is ignored when geographyTypes 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.

    It limits the search area around the provided coordinates. It must be a positive integer value.

    1

    Settings
    Member Visibility

    On This Page
    Properties