Skip to content

Latest commit

 

History

History
68 lines (35 loc) · 3 KB

AutocompletionRequest.md

File metadata and controls

68 lines (35 loc) · 3 KB

See html formatted version

AutocompletionRequest interface

google.maps.places.AutocompletionRequest interface

An Autocompletion request to be sent to AutocompleteService.getPlacePredictions.

Library

places

Properties

undefined

Type:  LatLngBounds|LatLngBoundsLiteral optional

Bounds for prediction biasing. Predictions will be biased towards, but not restricted to, the given bounds. Both location and radius will be ignored if bounds is set.

undefined

Type:  ComponentRestrictions optional

The component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country.

undefined

Type:  string

The user entered input string.

undefined

Type:  LatLng optional

Location for prediction biasing. Predictions will be biased towards the given location and radius. Alternatively, bounds can be used.

undefined

Type:  number optional

The character position in the input term at which the service uses text for predictions (the position of the cursor in the input field).

undefined

Type:  LatLng|LatLngLiteral optional

The location where AutocompletePrediction.distance_meters is calculated from.

undefined

Type:  number optional

The radius of the area used for prediction biasing. The radius is specified in meters, and must always be accompanied by a location property. Alternatively, bounds can be used.

undefined

Type:  AutocompleteSessionToken optional

Unique reference used to bundle individual requests into sessions.

undefined

Type:  Array optional

The types of predictions to be returned. For a list of supported types, see the developer's guide. If nothing is specified, all types are returned. In general only a single type is allowed. The exception is that you can safely mix the 'geocode' and 'establishment' types, but note that this will have the same effect as specifying no types.