TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ReverseGeocodingOptionalParams

    Optional parameters for customizing reverse geocoding requests.

    They set the geography types to return, the heading, the search radius and the geopolitical view.

    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: 67.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 positive.

    5000000

    Settings
    Member Visibility

    On This Page
    Properties