AutosuggestOptions class

Constructors

AutosuggestOptions()

Properties

clipToBoundingBox → String?

no setter

clipToCircle → String?

no setter

clipToCountry → String?

no setter

clipToPolygon → String?

no setter

focus → String?

no setter

hashCode → int

The hash code for this object.

no setter, inherited

inputType → String?

no setter

language → String?

no setter

nFocusResults → String?

no setter

nResults → String?

no setter

preferLand → String?

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setClipToBoundingBox(Coordinates southWest, Coordinates northEast) → AutosuggestOptions

Restrict autosuggest results to a Bounding Box.

setClipToCircle(Coordinates centre, double radius) → AutosuggestOptions

Restrict autosuggest results to a circle, specified by Coordinates representing the centre of the circle, plus the radius in kilometres. For convenience, longitude is allowed to wrap around 180 degrees. For example 181 is equivalent to -179.

setClipToCountry(List<String> countryCodes) → AutosuggestOptions

Restricts autosuggest to only return results inside the countries specified by comma-separated list of uppercase ISO 3166-1 alpha-2 country codes (for example, to restrict to Belgium and the UK, use [clipToCountry('GB', 'BE')]. clipToCountry will also accept lowercase country codes. Entries must be two a-z letters. WARNING: If the two-letter code does not correspond to a country, there is no error: API simply returns no results.

setClipToPolygon(List<Coordinates> polygon) → AutosuggestOptions

Restrict autosuggest results to a polygon, specified by a collection of Coordinates. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 entries. The API is currently limited to accepting up to 25 pairs.

setFocus(Coordinates coordinates) → AutosuggestOptions

This is a location, specified as a latitude (often where the user making the query is). If specified, the results will be weighted to give preference to those near the focus. For convenience, longitude is allowed to wrap around the 180 line, so 361 is equivalent to 1.

setInputType(AutosuggestInputType type) → AutosuggestOptions

For power users, used to specify voice input mode. Can be AutosuggestInputType.TEXT (default), AutosuggestInputType.VOCON_HYBRID, AutosuggestInputType.NMDP_ASR. See voice recognition section within the developer docs for more details https://docs.what3words.com/api/v3/#voice.

setLanguage(String language) → AutosuggestOptions

For normal text input, specifies a fallback language, which will help guide AutoSuggest if the input is particularly messy. If specified, this parameter must be a supported 3 word address language as an ISO 639-1 2 letter code. For voice input (see voice section), language must always be specified.

setNFocusResults(int n) → AutosuggestOptions

Specifies the number of results (must be <= nResults) within the results set which will have a focus. Defaults to nResults. This allows you to run autosuggest with a mix of focussed and unfocussed results, to give you a "blend" of the two. This is exactly what the old V2 standardblend did, and standardblend behaviour can easily be replicated by passing nFocusResults=1, which will return just one focussed result and the rest unfocussed.

setNResults(int n) → AutosuggestOptions

Set the number of AutoSuggest results to return. A maximum of 100 results can be specified, if a number greater than this is requested, this will be truncated to the maximum. The default is 3

setPreferLand(bool preferLand) → AutosuggestOptions

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited