DashSearchOptions

Search options, used for forward geocoding.

Properties

Link copied to clipboard
abstract val boundingBox: BoundingBox?

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian (longitude +/-180.0 deg.) and North or South pole (latitude +/- 90.0 deg.).

Link copied to clipboard
abstract val countries: List<String>?

Limit results to one or more countries.

Link copied to clipboard
abstract val fuzzyMatch: Boolean?

Specify whether the Geocoding API should attempt approximate, as well as exact, matching when performing searches (true, default), or whether it should opt out of this behavior and only attempt exact matching (false). For example, the default setting might return Washington, DC for a query of Washington, even though the query was misspelled.

Link copied to clipboard
abstract val languages: List<String>?

Specify the user’s language. This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich (“France”) with a German (de) language parameter. If language is not set explicitly, then language from default system locale will be used.

Link copied to clipboard
abstract val limit: Int?

Specify the maximum number of results to return. The maximum number of search results returned from the server is 10.

Link copied to clipboard
abstract val origin: Point?

Point for ETA calculation from it to search result.

Link copied to clipboard
abstract val proximity: Point?

Bias the response to favor results that are closer to this location, provided as Point.

Link copied to clipboard
abstract val types: List<QueryType>?

Filter results to include only a subset (one or more) of the available feature types. Options are country, region, postcode, district, place, locality, neighborhood, address, and poi.