This is the documentation of version 0.62.3. Go to the latest version, 1.0.0.
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 = {
        geographyTypes?: GeographyType[];
        geopoliticalView?: GeopoliticalView;
        heading?: number;
        radiusMeters?: number;
    }
    Index
    geographyTypes?: 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.

    geopoliticalView?: GeopoliticalView

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

    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 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.

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

    1