Documentation
    Preparing search index...

    Type Alias Location

    Represents a geographical object in terms of its position and its address.

    type Location = {
        city?: string | null;
        coordinate?: Coordinate;
        country?: string | null;
        description?: string | null;
        distance?: number | null;
        district?: string | null;
        houseNr?: string | null;
        postcode?: string | null;
        province?: string | null;
        score?: number;
        street?: string | null;
    }
    Index

    Properties

    city? coordinate? country? description? distance? district? houseNr? postcode? province? score? street?

    Properties

    city?: string | null

    The city of the address,

    coordinate?: Coordinate
    country?: string | null

    Country code according to ISO 3166-1 alpha-2. Defaults to NL. The search will be restricted to this country. When empty, all countries contained in the geocoding data will be included in the search.

    description?: string | null

    A single string representing the address, typically consisting of the street, house number, postal code, city, and country. The precise format may differ based on what is appropriate for the address.

    distance?: number | null

    A radius that specifies how close the route shall pass by the specified coordinate, only to be used with via waypoints. This radius refers to the distance on the road network in meters. When set there is no output waypoint. The route passes near the specified coordinate.

    district?: string | null

    The district of the address, i.e. the entity below city.

    houseNr?: string | null

    The HouseNr of the address

    postcode?: string | null

    The postal code of the address.

    province?: string | null

    The name of the principal country subdivision which the address belongs to

    score?: number

    Indicates the overall match quality for a geocoding request. 100 (percent) represents a perfect match between the input and the result.

    street?: string | null

    The street name of the address

    Settings

    Member Visibility

    On This Page

    Properties