Places Widgets

Autocomplete class

google.maps.places.Autocomplete class

A widget that provides Place predictions based on a user's text input. It attaches to an input element of type text, and listens for text entry in that field. The list of predictions is presented as a drop-down list, and is updated as text is entered.

This class extends MVCObject.

Load using the &libraries=places URL parameter. See Libraries in the Maps JavaScript API.

When using v=beta, can be accessed by calling const {Autocomplete} = await google.map.importLibrary("places"). See Libraries in the Maps JavaScript API.

Constructor
`Autocomplete`	`Autocomplete(inputField[, opts])` Parameters: `inputField`: `HTMLInputElement` The `<input>` text field to which the `Autocomplete` should be attached. `opts`: `AutocompleteOptions optional` Options. Creates a new instance of `Autocomplete` that attaches to the specified input text field with the given options.

Methods
`getBounds`	`getBounds()` Parameters: None Return Value: `LatLngBounds\|undefined` The biasing bounds. Returns the bounds to which predictions are biased.
`getFields`	`getFields()` Parameters: None Return Value: `Array<string>\|undefined` Returns the fields to be included for the Place in the details response when the details are successfully retrieved. For a list of fields see `PlaceResult`.
`getPlace`	`getPlace()` Parameters: None Return Value: `PlaceResult` The Place selected by the user. Returns the details of the Place selected by user if the details were successfully retrieved. Otherwise returns a stub Place object, with the `name` property set to the current value of the input field.
`setBounds`	`setBounds(bounds)` Parameters: `bounds`: `LatLngBounds\|LatLngBoundsLiteral optional` The biasing bounds. Return Value: None Sets the preferred area within which to return Place results. Results are biased towards, but not restricted to, this area.
`setComponentRestrictions`	`setComponentRestrictions(restrictions)` Parameters: `restrictions`: `ComponentRestrictions optional` The restrictions to use. Return Value: None Sets the component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country.
`setFields`	`setFields(fields)` Parameters: `fields`: `Array<string> optional` Return Value: None Sets the fields to be included for the Place in the details response when the details are successfully retrieved. For a list of fields see `PlaceResult`.
`setOptions`	`setOptions(options)` Parameters: `options`: `AutocompleteOptions optional` Return Value: None
`setTypes`	`setTypes(types)` Parameters: `types`: `Array<string> optional` The types of predictions to be included. Return Value: None Sets the types of predictions to be returned. For supported types, see the developer's guide. If no types are specified, all types will be returned.
Inherited: `addListener`, `bindTo`, `get`, `notify`, `set`, `setValues`, `unbind`, `unbindAll`

Events
`place_changed`	`function()` Arguments: None This event is fired when a `PlaceResult` is made available for a Place the user has selected. If the user enters the name of a Place that was not suggested by the control and presses the Enter key, or if a Place Details request fails, the `PlaceResult` contains the user input in the `name` property, with no other properties defined.

AutocompleteOptions interface

google.maps.places.AutocompleteOptions interface

The options that can be set on an Autocomplete object.

Load using the &libraries=places URL parameter. See Libraries in the Maps JavaScript API.

Properties
`bounds optional`	Type: `LatLngBounds\|LatLngBoundsLiteral optional` The area in which to search for places.
`componentRestrictions optional`	Type: `ComponentRestrictions optional` The component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country.
`fields optional`	Type: `Array<string> 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"`). The default is `['ALL']`.
`placeIdOnly optional`	Deprecated: `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.
`strictBounds optional`	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.
`types optional`	Type: `Array<string> optional` The types of predictions to be returned. For supported types, see the developer's guide. If no types are specified, all types will be returned.

google.maps.places.SearchBox class

A widget that provides query predictions based on a user's text input. It attaches to an input element of type text, and listens for text entry in that field. The list of predictions is presented as a drop-down list, and is updated as text is entered.

This class extends MVCObject.

Load using the &libraries=places URL parameter. See Libraries in the Maps JavaScript API.

When using v=beta, can be accessed by calling const {SearchBox} = await google.map.importLibrary("places"). See Libraries in the Maps JavaScript API.

Constructor
`SearchBox`	`SearchBox(inputField[, opts])` Parameters: `inputField`: `HTMLInputElement` `opts`: `SearchBoxOptions optional` Creates a new instance of `SearchBox` that attaches to the specified input text field with the given options.

Methods
`getBounds`	`getBounds()` Parameters: None Return Value: `LatLngBounds\|undefined` Returns the bounds to which query predictions are biased.
`getPlaces`	`getPlaces()` Parameters: None Return Value: `Array<PlaceResult>\|undefined` Returns the query selected by the user to be used with `places_changed` event.
`setBounds`	`setBounds(bounds)` Parameters: `bounds`: `LatLngBounds\|LatLngBoundsLiteral optional` Return Value: None Sets the region to use for biasing query predictions. Results will only be biased towards this area and not be completely restricted to it.
Inherited: `addListener`, `bindTo`, `get`, `notify`, `set`, `setValues`, `unbind`, `unbindAll`

Events
`places_changed`	`function()` Arguments: None This event is fired when the user selects a query, `getPlaces` should be used to get new places.

SearchBoxOptions interface

google.maps.places.SearchBoxOptions interface

The options that can be set on a SearchBox object.

Load using the &libraries=places URL parameter. See Libraries in the Maps JavaScript API.

Properties
`bounds optional`	Type: `LatLngBounds\|LatLngBoundsLiteral optional` The area towards which to bias query predictions. Predictions are biased towards, but not restricted to, queries targeting these bounds.

Places Widgets

Autocomplete class

Constructor

Methods

Events

AutocompleteOptions interface

Properties

SearchBox class

Constructor

Methods

Events

SearchBoxOptions interface

Properties