Options
All
  • Public
  • Public/Protected
  • All
Menu

An Autocompletion request to be sent to google.maps.places.AutocompleteService.getPlacePredictions.

Hierarchy

  • AutocompletionRequest

Index

Properties

Optional bounds

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.

Optional componentRestrictions

componentRestrictions?: ComponentRestrictions

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

input

input: string

The user entered input string.

Optional location

location?: LatLng

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

Optional offset

offset?: number

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

Optional origin

The location where google.maps.places.AutocompletePrediction.distance_meters is calculated from.

Optional radius

radius?: number

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.

Optional sessionToken

Unique reference used to bundle individual requests into sessions.

Optional types

types?: string[]

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.

Generated using TypeDoc