A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.google.com/maps/documentation/javascript/reference/places-widget below:

Places Widgets | Maps JavaScript API

Skip to main content Places Widgets

Stay organized with collections Save and categorize content based on your preferences.

PlaceAutocompleteElement class

google.maps.places.PlaceAutocompleteElement class

PlaceAutocompleteElement is an HTMLElement subclass which provides a UI component for the Places Autocomplete API.

PlaceAutocompleteElement automatically uses AutocompleteSessionTokens internally to group the query and selection phases of a user's autocomplete search.

The first call to Place.fetchFields on a Place returned by PlacePrediction.toPlace will automatically include the session token used to fetch the PlacePrediction.

See https://developers.google.com/maps/documentation/places/web-service/place-session-tokens for more details on how sessions work.

Custom element:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng" requested-language="string" requested-region="string" unit-system="metric"></gmp-place-autocomplete>

This class extends HTMLElement.

This class implements PlaceAutocompleteElementOptions.

Access by calling const {PlaceAutocompleteElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties includedPrimaryTypes Type:  Array<string> optional

Included primary

Place type

(for example, "restaurant" or "gas_station").

A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.

HTML attribute: includedRegionCodes Type:  Array<string> optional

Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both locationRestriction and includedRegionCodes are set, the results will be located in the area of intersection.

HTML attribute: locationBias Type:  LocationBias optional

A soft boundary or hint to use when searching for places.

locationRestriction Type:  LocationRestriction optional

Bounds to constrain search results.

name

Type:  string optional

The name to be used for the input element. See

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name

for details. Follows the same behavior as the name attribute for inputs. Note that this is the name that will be used when a form is submitted. See

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form

for details.

HTML attribute: origin Type:  LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional

The origin from which to calculate distance. If not specified, distance is not calculated. The altitude, if given, is not used in the calculation.

HTML attribute: requestedLanguage

Type:  string optional

A language identifier for the language in which the results should be returned, if possible. Results in the selected language may be given a higher ranking, but suggestions are not restricted to this language. See the

list of supported languages

.

HTML attribute: requestedRegion

Type:  string optional

A region code which is used for result formatting and for result filtering. It does not restrict the suggestions to this country. The region code accepts a

ccTLD ("top-level domain")

two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is "uk" (

.co.uk

) while its ISO 3166-1 code is "gb" (technically for the entity of "The United Kingdom of Great Britain and Northern Ireland").

HTML attribute: unitSystem Type:  UnitSystem optional

The unit system used to display distances. If not specified, the unit system is determined by requestedRegion.

HTML attribute: Parts prediction-item

An item in the drop down of predictions that represents a single prediction.

prediction-item-icon

The icon displayed to the left of each item in the list of predictions.

prediction-item-main-text

A part of prediction-item that is the main text of the prediction. For geographic locations, this contains a place name, like 'Sydney', or a street name and number, like '10 King Street'. By default, the prediction-item-main-text is colored black. If there is any additional text in the prediction-item, it is outside prediction-item-main-text and inherits its styling from prediction-item. It is colored gray by default. The additional text is typically an address.

prediction-item-match

The part of the returned prediction that matches the user’s input. By default, this matched text is highlighted in bold text. Note that the matched text may be anywhere within prediction-item. It is not necessarily part of prediction-item-main-text.

prediction-item-selected

The item when the user navigates to it via the keyboard. Note: Selected items will be affected by both this part styles and also the prediction-item part styles.

prediction-list

The visual element containing the list of predictions returned by the Place Autocomplete service. This list appears as a dropdown list below the PlaceAutocompleteElement.

CSS Properties background-color

Overrides the background color of the element.

border

Overrides the border of the element.

border-radius

Overrides the border radius of the element.

color-scheme

Indicates which color scheme this element can be rendered in. See

color-scheme documentation

for more details. Defaults to

color-scheme: light dark

.

Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

Events gmp-error

function(errorEvent)

Arguments: 

This event is fired when a request to the backend was denied (e.g. incorrect API key). This event does not bubble.

gmp-select

function(placePredictionSelectEvent)

Arguments: 

This event is fired when a user selects a place prediction. Contains a PlacePrediction object which can be converted to a Place object.

PlaceAutocompleteElementOptions interface

google.maps.places.PlaceAutocompleteElementOptions interface

Options for constructing a PlaceAutocompleteElement. For the description of each property, refer to the property of the same name in the PlaceAutocompleteElement class.

PlacePredictionSelectEvent class

google.maps.places.PlacePredictionSelectEvent class

This event is created after the user selects a prediction item with the PlaceAutocompleteElement. Access the selection with event.placePrediction.

Convert placePrediction to a Place by calling PlacePrediction.toPlace.

This class extends Event.

Access by calling const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceAutocompleteRequestErrorEvent class

google.maps.places.PlaceAutocompleteRequestErrorEvent class

Deprecated: The gmp-requesterror event will continue to trigger in the beta channel, but will not trigger in alpha or at release. For migration purposes, continue to listen to the gmp-requesterror event, but also add an event listener for the gmp-error event, which returns an Event object.

Notice: Available only in the v=beta channel.

This event is emitted by the PlaceAutocompleteElement when there is an issue with the network request.

This class extends Event.

Access by calling const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceContextualElement class

google.maps.places.PlaceContextualElement class

Notice: Available only in the v=alpha channel.

A widget that uses the context token to display a contextual view of the Grounding with Google Maps response.

Custom element:
<gmp-place-contextual context-token="string"></gmp-place-contextual>

This class extends HTMLElement.

This class implements PlaceContextualElementOptions.

Access by calling const {PlaceContextualElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties contextToken

Type:  string optional

The context token.

HTML attribute: Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

PlaceContextualElementOptions interface

google.maps.places.PlaceContextualElementOptions interface

Notice: Available only in the v=alpha channel.

Options for PlaceContextualElement.

Properties contextToken optional

Type:  string optional

The context token provided by the Grounding with Google Maps response.

PlaceContextualListConfigElement class

google.maps.places.PlaceContextualListConfigElement class

Notice: Available only in the v=alpha channel.

An HTML element that configures options for the Place Contextual Element's list view.

Custom element:
<gmp-place-contextual-list-config layout="compact" map-hidden></gmp-place-contextual-list-config>

This class extends HTMLElement.

This class implements PlaceContextualListConfigElementOptions.

Access by calling const {PlaceContextualListConfigElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties layout Type:  PlaceContextualListLayout optional

The layout.

HTML attribute: mapHidden

Type:  boolean optional

Whether the map is hidden.

HTML attribute: Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

PlaceContextualListLayout constants

google.maps.places.PlaceContextualListLayout constants

Notice: Available only in the v=alpha channel.

The list of layouts that the Place Contextual Element supports for the list view.

Access by calling const {PlaceContextualListLayout} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Constants COMPACT Compact list layout: list items are rendered as links across a single line, with overflows in a dropdown list. VERTICAL Vertical list layout: list items are rendered as cards in a vertical list. PlaceDetailsElement class

google.maps.places.PlaceDetailsElement class

Displays details for a place in a full layout. Append either a PlaceDetailsPlaceRequestElement or PlaceDetailsLocationRequestElement to specify the place to be rendered. Append a PlaceContentConfigElement, PlaceStandardContentElement, or PlaceAllContentElement to specify which content to render.

Example:

 <gmp-place-details>
  <gmp-place-details-place-request
    place="PLACE_ID"
  ></gmp-place-details-place-request>
  <gmp-place-content-config>
    <gmp-place-media lightbox-preferred></gmp-place-media>
  </gmp-place-content-config>
</gmp-place-details>

To use this element, enable the

Places UI Kit API

for your project in the Google Cloud console.

Custom element:
<gmp-place-details></gmp-place-details>

This class extends HTMLElement.

This class implements PlaceDetailsElementOptions.

Access by calling const {PlaceDetailsElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties place Type:  Place optional

Read only. Place object containing the ID, location, and viewport of the currently rendered place.

CSS Properties --gmp-mat-color-disabled-surface

Surface color intended to convey disabled states or non-presence. Used for empty review stars.

--gmp-mat-color-info

Color of UI elements with informational sentiment. Used for the wheelchair icon.

--gmp-mat-color-negative

Color of UI elements with negative sentiment. Used for "Closed" text in open now status.

--gmp-mat-color-neutral-container

Container color for neutral filled UI elements. Used for image placeholders and review published date badge.

--gmp-mat-color-on-neutral-container

Color of text and icons against the neutral container color. Used for the review published date badge and EV charger availability badge when unavailable.

--gmp-mat-color-on-positive-container

Color of texts and icons against the positive container color. Used for the EV charger availability badge when available.

--gmp-mat-color-on-secondary-container

Color of text and icons against the secondary container color. Used for text and icons on the "Open in Maps" button.

--gmp-mat-color-on-surface

Color for text and icons against any surface color. Used for regular text.

--gmp-mat-color-on-surface-variant

Lower-emphasis color for text and icons against any surface color. Used for less emphasized text.

--gmp-mat-color-outline-decorative

Outline color of non-interactive elements. Used for the element's border.

--gmp-mat-color-positive

Color of UI elements with positive sentiment. Used for "Open" text in open now status.

--gmp-mat-color-positive-container

Container color for UI elements that convey positive sentiment. Used for the EV charger availability badge when available.

--gmp-mat-color-primary

Color of interactive text and icons against the surface color. Used for review count, links in the Google Maps disclosures dialog, website link, icons in the overview tab, and (hover / focus / text color) on tab bar titles.

--gmp-mat-color-secondary-container

Less prominent fill color against surface, for recessive components like tonal buttons. Used for the background of the "Open in Maps" button.

--gmp-mat-color-surface

Color for backgrounds. Used for the backgrounds of the element and the Google Maps disclosures dialog.

--gmp-mat-font-body-medium

Used for the place address, rating, type, price, open now status, opening hours, review, phone number, website, plus code, top features, and body text in the Google Maps disclosures dialog.

--gmp-mat-font-body-small

Used for body text in the features list in the 'About' tab.

--gmp-mat-font-display-small

Used for the place name and the text for each feature heading in the 'About' tab.

--gmp-mat-font-family

Base font family used for all text.

--gmp-mat-font-headline-medium

Used for heading text in the Google Maps disclosures dialog.

--gmp-mat-font-label-large

Used for the tab titles, the "Open in Maps" button, reviewer attribution text in the photo gallery, reviewer attribution text in the reviews section, and links in the Google Maps disclosures dialog.

--gmp-mat-font-label-medium

Used for the photos count badge and the review published date bage.

--gmp-mat-font-title-small

Used for the title of each section in the 'About' tab.

background-color

Overrides the background color of the element.

border

Overrides the border of the element.

border-radius

Overrides the border radius of the element.

color-scheme

Indicates which color scheme this element can be rendered in. See

color-scheme documentation

for more details. Defaults to

color-scheme: light dark

.

font-size

Scales all text and icons in the element, which are defined internally in ems. Defaults to 16px.

Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

Events gmp-error

function(event)

Arguments: 

This event is fired when a request to the backend was denied (e.g. incorrect API key). This event does not bubble.

gmp-load

function(event)

Arguments: 

This event is fired when the element loads and renders its content. This event does not bubble.

PlaceDetailsCompactElement class

google.maps.places.PlaceDetailsCompactElement class

Displays details for a place in a compact layout. Append a PlaceDetailsPlaceRequestElement or PlaceDetailsLocationRequestElement to specify the place to be rendered. Append a PlaceContentConfigElement, PlaceStandardContentElement, or PlaceAllContentElement to specify which content to render.

Example:

 <gmp-place-details-compact>
  <gmp-place-details-place-request
    place="PLACE_ID"
  ></gmp-place-details-place-request>
  <gmp-place-content-config>
    <gmp-place-media lightbox-preferred></gmp-place-media>
  </gmp-place-content-config>
</gmp-place-details-compact>

To use this element, enable the

Places UI Kit API

for your project in the Google Cloud console.

Custom element:
<gmp-place-details-compact orientation="vertical" truncation-preferred></gmp-place-details-compact>

This class extends HTMLElement.

This class implements PlaceDetailsCompactElementOptions.

Access by calling const {PlaceDetailsCompactElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties orientation Type:  PlaceDetailsOrientation optional

Default: PlaceDetailsOrientation.VERTICAL

The orientation variant (vertical or horizontal) of the element.

HTML attribute: place Type:  Place optional

Read only. Place object containing the ID, location, and viewport of the currently rendered place.

truncationPreferred

Type:  boolean

Default: false

If true, truncates the place name and address to fit on one line instead of wrapping.

HTML attribute: Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

Events gmp-error

function(event)

Arguments: 

This event is fired when a request to the backend was denied (e.g. incorrect API key). This event does not bubble.

gmp-load

function(event)

Arguments: 

This event is fired when the element loads and renders its content. This event does not bubble.

PlaceDetailsPlaceRequestElement class

google.maps.places.PlaceDetailsPlaceRequestElement class

Configures a PlaceDetailsCompactElement or PlaceDetailsElement to load data based on a place object, ID, or resource name. Append this element as a child of a PlaceDetailsCompactElement or PlaceDetailsElement to load data for the specified place. For example:

 <gmp-place-details>
  <gmp-place-details-place-request
    place="PLACE_ID"
  ></gmp-place-details-place-request>
</gmp-place-details>

Custom element:
<gmp-place-details-place-request place="some-place-id"></gmp-place-details-place-request>

This class extends HTMLElement.

This class implements PlaceDetailsPlaceRequestElementOptions.

Access by calling const {PlaceDetailsPlaceRequestElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties place Type:  Place optional

Default: null

The place object, ID, or resource name to render details for in the Place Details Compact element. This property reflects to the attribute as a resource name.

HTML attribute: Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

PlaceContentConfigElement class

google.maps.places.PlaceContentConfigElement class

Configures a PlaceDetailsCompactElement or PlaceDetailsElement to show a custom set of content. Append this element as a child to use it.

For PlaceDetailsCompactElement or PlaceDetailsElement, append any of the following elements to the PlaceContentConfigElement to show the corresponding content:


PlaceAddressElement, PlaceAccessibleEntranceIconElement, PlaceAttributionElement PlaceMediaElement, PlaceOpenNowStatusElement, PlacePriceElement, PlaceRatingElement, PlaceTypeElement.

Specific to PlaceDetailsElement, you may also append any of the following elements:


PlaceFeatureListElement PlaceOpeningHoursElement, PlacePhoneNumberElement, PlacePlusCodeElement, PlaceReviewsElement, PlaceSummaryElement, PlaceTypeSpecificHighlightsElement, PlaceWebsiteElement.

The order of the children does not matter; the element renders content in a standard order which is not customizable. Example:

 <gmp-place-details>
  <gmp-place-content-config>
    <gmp-place-media lightbox-preferred></gmp-place-media>
    <gmp-place-address></gmp-place-address>
  </gmp-place-content-config>
</gmp-place-details>

Custom element:
<gmp-place-content-config></gmp-place-content-config>

This class extends HTMLElement.

This class implements PlaceContentConfigElementOptions.

Access by calling const {PlaceContentConfigElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

PlaceListElement class

google.maps.places.PlaceListElement class

Notice: Available only in the v=alpha channel.

An HTML element that displays the results of a place search in a list. Use the configureFromSearchByTextRequest() or configureFromSearchNearbyRequest() methods to specify the request to render results for. To use the Place List Element, enable the Places UI Kit API for your project in the Google Cloud console.

Custom element:
<gmp-place-list selectable></gmp-place-list>

This class extends HTMLElement.

This class implements PlaceListElementOptions.

Access by calling const {PlaceListElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties places Type:  Array<Place>

Read only. Array of Place objects containing the IDs, locations, and viewports of the currently rendered places.

selectable

Type:  boolean

Whether or not the list items are selectable. If true, the list items will be buttons that dispatch the gmp-placeselect event when clicked. Accessible keyboard navigation and selection is also supported.

HTML attribute: Methods addEventListener

Notice: Available only in the v=beta channel.

addEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Sets up a function that will be called whenever the specified event is delivered to the target. See

addEventListener

.

configureFromSearchByTextRequest

configureFromSearchByTextRequest(request)

Parameters:  Return Value:  Promise<void>

A promise that resolves once place data is loaded and rendered.

Configures the widget to render search results from a Places Text Search API request.

configureFromSearchNearbyRequest

configureFromSearchNearbyRequest(request)

Parameters:  Return Value:  Promise<void>

A promise that resolves once place data is loaded and rendered.

Configures the widget to render search results from a Places Nearby Search API request.

removeEventListener

Notice: Available only in the v=beta channel.

removeEventListener(type, listener[, options])

Parameters: 

Return Value:  void

Removes an event listener previously registered with addEventListener from the target. See

removeEventListener

.

Events gmp-load

function(event)

Arguments: 

This event is fired when the element loads and renders its content. This event does not bubble.

gmp-placeselect

function(event)

Arguments: 

This event is fired when a user selects a place. Contains a Place object and the index of the selected place in the list.

gmp-requesterror

function(event)

Arguments: 

This event is fired when a request to the backend was denied (e.g. incorrect API key). This event does not bubble.

PlaceListPlaceSelectEvent class

google.maps.places.PlaceListPlaceSelectEvent class

Notice: Available only in the v=alpha channel.

This event is emitted by the PlaceListElement when the user selects a place.

This class extends Event.

Access by calling const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Properties index

Type:  number

The list index of the selected place.

place Type:  Place

A Place object containing the ID, location, and viewport of the selected place.

Autocomplete class

google.maps.places.Autocomplete class

Deprecated: As of March 1st, 2025, google.maps.places.Autocomplete is not available to new customers. Please use PlaceAutocompleteElement instead. At this time, google.maps.places.Autocomplete is not scheduled to be discontinued, but PlaceAutocompleteElement is recommended over google.maps.places.Autocomplete. While google.maps.places.Autocomplete will continue to receive bug fixes for any major regressions, existing bugs in google.maps.places.Autocomplete will not be addressed. At least 12 months notice will be given before support is discontinued. Please see https://developers.google.com/maps/legacy for additional details and https://developers.google.com/maps/documentation/javascript/places-migration-overview for the migration guide.

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.

Access by calling const {Autocomplete} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Constructor Autocomplete

Autocomplete(inputField[, opts])

Parameters: 

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: 

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: 

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: 

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: 

Return Value:  None

setTypes

setTypes(types)

Parameters: 

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.

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']

.

placeIdOnlyoptional

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.

SearchBox class

google.maps.places.SearchBox class

Deprecated: As of March 1st, 2025, google.maps.places.SearchBox is not available to new customers. At this time, google.maps.places.SearchBox is not scheduled to be discontinued and will continue to receive bug fixes for any major regressions. At least 12 months notice will be given before support is discontinued. Please see https://developers.google.com/maps/legacy for additional details.

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.

Access by calling const {SearchBox} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Constructor SearchBox

SearchBox(inputField[, opts])

Parameters: 

Creates a new instance of SearchBox that attaches to the specified input text field with the given options.

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.

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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-10 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-10 UTC."],[],[]]


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4