Skip to content

Latest commit

 

History

History
52 lines (27 loc) · 2.96 KB

AutocompleteOptions.md

File metadata and controls

52 lines (27 loc) · 2.96 KB

See html formatted version

AutocompleteOptions interface

google.maps.places.AutocompleteOptions interface

The options that can be set on an Autocomplete object.

Library

places

Properties

undefined

Type:  LatLngBounds|LatLngBoundsLiteral optional

The area in which to search for places.

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:  Array optional

Fields to be included for the Place in the details response when the details are successfully retrieved, which will be billed for. If ['ALL'] is passed in, all available fields will be returned and billed for (this is not recommended for production deployments). For a list of fields see PlaceResult. Nested fields can be specified with dot-paths (for example, "geometry.location").

undefined

Notice: placeIdOnly is deprecated as of January 15, 2019, and will be turned off on January 15, 2020. Use AutocompleteOptions.fields instead: fields: ['place_id', 'name', 'types'].

Type:  boolean optional

Whether to retrieve only Place IDs. The PlaceResult made available when the place_changed event is fired will only have the place_id, types and name fields, with the place_id, types and description returned by the Autocomplete service. Disabled by default.

undefined

Type:  boolean optional

A boolean value, indicating that the Autocomplete widget should only return those places that are inside the bounds of the Autocomplete widget at the time the query is sent. Setting strictBounds to false (which is the default) will make the results biased towards, but not restricted to, places contained within the bounds.

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.