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 AutocompleteSessionToken
s 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.
Constructor | |
---|---|
PlaceAutocompleteElement |
PlaceAutocompleteElement(options) Parameters:
|
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. |
Methods | |
---|---|
|
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(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.
Properties | |
---|---|
locationBias optional |
Type:
LocationBias optional |
locationRestriction optional |
Type:
LocationRestriction optional |
name optional |
Type:
string optional |
requestedLanguage optional |
Type:
string optional |
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.
Properties | |
---|---|
placePrediction |
Type:
PlacePrediction Convert this to a Place by calling PlacePrediction.toPlace . |
PlaceAutocompleteRequestErrorEvent class
google.maps.places.PlaceAutocompleteRequestErrorEvent
class
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
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(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(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
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
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(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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceContextualListConfigElementOptions interface
google.maps.places.PlaceContextualListConfigElementOptions
interface
Options for PlaceContextualListConfigElement.
Properties | |
---|---|
layout optional |
Type:
PlaceContextualListLayout optional The layout. Default is PlaceContextualListLayout.VERTICAL . |
mapHidden optional |
Type:
boolean optional Whether the map is hidden. Default is to show the map (value false). |
PlaceContextualListLayout constants
google.maps.places.PlaceContextualListLayout
constants
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
An HTML element that displays details for a place. Use the configureFromPlace()
or configureFromLocation()
methods to specify the content to be rendered. To use the Place Details Element, enable the Places UI Kit API for your project in the Google Cloud console.
Custom element:
<gmp-place-details size="small"></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.
Constructor | |
---|---|
PlaceDetailsElement |
PlaceDetailsElement([options]) Parameters:
|
Properties | |
---|---|
place |
Type:
Place optional Read only. Place object containing the ID, location, and viewport of the currently rendered place. |
size |
Type:
PlaceDetailsSize optional The size variant of the PlaceDetailsElement. By default, the element will display
PlaceDetailsSize.X_LARGE .HTML attribute:
|
Methods | |
---|---|
|
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. |
configureFromLocation |
configureFromLocation(location) Parameters:
Return Value:
Promise<void> A promise that resolves once place data is loaded and rendered.Configures the widget from a LatLng using reverse geocoding. |
configureFromPlace |
configureFromPlace(place) Parameters:
Return Value:
Promise<void> A promise that resolves once place data is loaded and rendered.Configures the widget from a Place object or Place ID. |
|
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-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. |
PlaceDetailsElementOptions interface
google.maps.places.PlaceDetailsElementOptions
interface
Options for PlaceDetailsElement
.
Properties | |
---|---|
size optional |
Type:
PlaceDetailsSize optional |
PlaceDetailsSize constants
google.maps.places.PlaceDetailsSize
constants
Size variants for PlaceDetailsElement
.
Access by calling const {PlaceDetailsSize} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constants | |
---|---|
LARGE |
Large variant including a large image, basic information, and contact information. |
MEDIUM |
Medium variant including a large image and basic information. |
SMALL |
Small variant including a small image and basic information. |
X_LARGE |
Extra large variant including a photo collage, reviews, and comprehensive place information. |
PlaceDetailsCompactElement class
google.maps.places.PlaceDetailsCompactElement
class
Displays details for a place in a compact layout. Append a PlaceDetailsPlaceRequestElement
to specify the place to be rendered. Append a PlaceContentConfigElement
, PlaceStandardContentElement
, or PlaceAllContentElement
to specify which content to render.
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.
Constructor | |
---|---|
PlaceDetailsCompactElement |
PlaceDetailsCompactElement([options]) Parameters:
|
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:
|
CSS Properties | |
---|---|
--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. |
--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-primary |
Color of interactive text and icons against the surface color. Used for review count and links in the attribution dialog. |
--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 attribution dialog. |
--gmp-mat-font-body-medium |
Used for body text in the attribution dialog. |
--gmp-mat-font-body-small |
Used for the place address, rating, type, price, and open now status. |
--gmp-mat-font-family |
Base font family used for all text. |
--gmp-mat-font-headline-medium |
Used for heading text in the attribution dialog. |
--gmp-mat-font-label-large |
Used for the "Open in Maps" button and links in the attribution dialog. |
--gmp-mat-font-title-small |
Used for the place name. |
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(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(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. |
PlaceDetailsCompactElementOptions interface
google.maps.places.PlaceDetailsCompactElementOptions
interface
Options for PlaceDetailsCompactElement
.
Properties | |
---|---|
orientation optional |
Type:
PlaceDetailsOrientation optional |
truncationPreferred optional |
Type:
boolean optional |
PlaceDetailsOrientation constants
google.maps.places.PlaceDetailsOrientation
constants
Orientation variants for PlaceDetailsCompactElement
.
Access by calling const {PlaceDetailsOrientation} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constants | |
---|---|
HORIZONTAL |
Horizontal orientation. |
VERTICAL |
Vertical orientation. |
PlaceDetailsPlaceRequestElement class
google.maps.places.PlaceDetailsPlaceRequestElement
class
Configures a Place Details Compact element to load data based on a place object, ID, or resource name. Append this element as a child of a PlaceDetailsCompactElement
to load data for the specified place.
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.
Constructor | |
---|---|
PlaceDetailsPlaceRequestElement |
PlaceDetailsPlaceRequestElement([options]) Parameters:
|
Properties | |
---|---|
place |
Type:
Place optional 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(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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceDetailsPlaceRequestElementOptions interface
google.maps.places.PlaceDetailsPlaceRequestElementOptions
interface
Options for PlaceDetailsPlaceRequestElement
.
Properties | |
---|---|
place optional |
Type:
Place|string optional |
PlaceContentConfigElement class
google.maps.places.PlaceContentConfigElement
class
Configures the content to be shown by a Place Details Compact element. Append this element as a child of a PlaceDetailsCompactElement
to use it. Append any of the following elements to the PlaceContentConfigElement
to show the corresponding content:
PlaceMediaElement
, PlaceAddressElement
, PlaceRatingElement
, PlaceTypeElement
, PlacePriceElement
, PlaceAccessibleEntranceIconElement
, PlaceOpenNowStatusElement
, PlaceAttributionElement
The order of the children does not matter; the element renders content in a standard order which is not customizable.
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.
Constructor | |
---|---|
PlaceContentConfigElement |
PlaceContentConfigElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceContentConfigElementOptions interface
google.maps.places.PlaceContentConfigElementOptions
interface
Options for PlaceContentConfigElement
.
PlaceMediaElement class
google.maps.places.PlaceMediaElement
class
Configures a Place Details Compact element to show a place's media, such as photos. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-media lightbox-preferred></gmp-place-media>
This class extends
HTMLElement
.
This class implements
PlaceMediaElementOptions
.
Access by calling const {PlaceMediaElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceMediaElement |
PlaceMediaElement([options]) Parameters:
|
Properties | |
---|---|
lightboxPreferred |
Type:
boolean optional Default:
false Whether to enable or disable the media lightbox, in cases where both options are supported.
HTML attribute:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceMediaElementOptions interface
google.maps.places.PlaceMediaElementOptions
interface
Options for PlaceMediaElement
.
Properties | |
---|---|
lightboxPreferred optional |
Type:
boolean optional |
PlaceAddressElement class
google.maps.places.PlaceAddressElement
class
Configures a Place Details Compact element to show a place's address. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-address></gmp-place-address>
This class extends
HTMLElement
.
This class implements
PlaceAddressElementOptions
.
Access by calling const {PlaceAddressElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceAddressElement |
PlaceAddressElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceAddressElementOptions interface
google.maps.places.PlaceAddressElementOptions
interface
Options for PlaceAddressElement
.
PlaceRatingElement class
google.maps.places.PlaceRatingElement
class
Configures a Place Details Compact element to show a place's rating. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-rating></gmp-place-rating>
This class extends
HTMLElement
.
This class implements
PlaceRatingElementOptions
.
Access by calling const {PlaceRatingElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceRatingElement |
PlaceRatingElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceRatingElementOptions interface
google.maps.places.PlaceRatingElementOptions
interface
Options for PlaceRatingElement
.
PlaceTypeElement class
google.maps.places.PlaceTypeElement
class
Configures a Place Details Compact element to show a place's type. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-type></gmp-place-type>
This class extends
HTMLElement
.
This class implements
PlaceTypeElementOptions
.
Access by calling const {PlaceTypeElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceTypeElement |
PlaceTypeElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceTypeElementOptions interface
google.maps.places.PlaceTypeElementOptions
interface
Options for PlaceTypeElement
.
PlacePriceElement class
google.maps.places.PlacePriceElement
class
Configures a Place Details Compact element to show a place's price level or price range. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-price></gmp-place-price>
This class extends
HTMLElement
.
This class implements
PlacePriceElementOptions
.
Access by calling const {PlacePriceElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlacePriceElement |
PlacePriceElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlacePriceElementOptions interface
google.maps.places.PlacePriceElementOptions
interface
Options for PlacePriceElement
.
PlaceAccessibleEntranceIconElement class
google.maps.places.PlaceAccessibleEntranceIconElement
class
Configures a Place Details Compact element to show a wheelchair icon if the place has an accessible entrance. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-accessible-entrance-icon></gmp-place-accessible-entrance-icon>
This class extends
HTMLElement
.
This class implements
PlaceAccessibleEntranceIconElementOptions
.
Access by calling const {PlaceAccessibleEntranceIconElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceAccessibleEntranceIconElement |
PlaceAccessibleEntranceIconElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceAccessibleEntranceIconElementOptions interface
google.maps.places.PlaceAccessibleEntranceIconElementOptions
interface
Options for PlaceAccessibleEntranceIconElement
.
PlaceOpenNowStatusElement class
google.maps.places.PlaceOpenNowStatusElement
class
Configures a Place Details Compact element to show the current open or closed status of a place. Append this element as a child of a PlaceContentConfigElement
to use it.
Custom element:
<gmp-place-open-now-status></gmp-place-open-now-status>
This class extends
HTMLElement
.
This class implements
PlaceOpenNowStatusElementOptions
.
Access by calling const {PlaceOpenNowStatusElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceOpenNowStatusElement |
PlaceOpenNowStatusElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceOpenNowStatusElementOptions interface
google.maps.places.PlaceOpenNowStatusElementOptions
interface
Options for PlaceOpenNowStatusElement
.
PlaceAttributionElement class
google.maps.places.PlaceAttributionElement
class
Allows customization of the Google Maps attribution text in a Place Details Compact element. Append this element as a child of a PlaceContentConfigElement
to use it. If this element is omitted, attribution will still be shown with default colors.
Custom element:
<gmp-place-attribution dark-scheme-color="white" light-scheme-color="white"></gmp-place-attribution>
This class extends
HTMLElement
.
This class implements
PlaceAttributionElementOptions
.
Access by calling const {PlaceAttributionElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceAttributionElement |
PlaceAttributionElement([options]) Parameters:
|
Properties | |
---|---|
darkSchemeColor |
Type:
AttributionColor optional Default:
AttributionColor.WHITE The color of the Google Maps attribution in dark mode.
HTML attribute:
|
lightSchemeColor |
Type:
AttributionColor optional Default:
AttributionColor.GRAY The color of the Google Maps attribution in light mode.
HTML attribute:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceAttributionElementOptions interface
google.maps.places.PlaceAttributionElementOptions
interface
Options for PlaceAttributionElement
.
Properties | |
---|---|
darkSchemeColor optional |
Type:
AttributionColor optional |
lightSchemeColor optional |
Type:
AttributionColor optional |
AttributionColor constants
google.maps.places.AttributionColor
constants
Color options for Google Maps attribution text. Attribution may be customized to use any of these colors.
Access by calling const {AttributionColor} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constants | |
---|---|
BLACK |
Black attribution text. |
GRAY |
Gray attribution text. |
WHITE |
White attribution text. |
PlaceAllContentElement class
google.maps.places.PlaceAllContentElement
class
Configures a Place Details Compact element to show all available content. Append this element as a child of a PlaceDetailsCompactElement
to use it.
Custom element:
<gmp-place-all-content></gmp-place-all-content>
This class extends
HTMLElement
.
This class implements
PlaceAllContentElementOptions
.
Access by calling const {PlaceAllContentElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceAllContentElement |
PlaceAllContentElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceAllContentElementOptions interface
google.maps.places.PlaceAllContentElementOptions
interface
Options for PlaceAllContentElement
.
PlaceStandardContentElement class
google.maps.places.PlaceStandardContentElement
class
Configures a Place Details Compact element to show a standard set of content (media, rating, type, price, accessible entrance icon, and open now status). Append this element as a child of a PlaceDetailsCompactElement
to use it.
Custom element:
<gmp-place-standard-content></gmp-place-standard-content>
This class extends
HTMLElement
.
This class implements
PlaceStandardContentElementOptions
.
Access by calling const {PlaceStandardContentElement} = await google.maps.importLibrary("places")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
PlaceStandardContentElement |
PlaceStandardContentElement([options]) Parameters:
|
Methods | |
---|---|
|
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(type, listener[, options]) Parameters:
Return Value:
void Removes an event listener previously registered with addEventListener from the target. See removeEventListener. |
PlaceStandardContentElementOptions interface
google.maps.places.PlaceStandardContentElementOptions
interface
Options for PlaceStandardContentElement
.
PlaceListElement class
google.maps.places.PlaceListElement
class
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.
Constructor | |
---|---|
PlaceListElement |
PlaceListElement([options]) Parameters:
|
Properties | |
---|---|
places |
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(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(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. |
PlaceListElementOptions interface
google.maps.places.PlaceListElementOptions
interface
Options for PlaceListElement
.
Properties | |
---|---|
selectable optional |
Type:
boolean optional |
PlaceListPlaceSelectEvent class
google.maps.places.PlaceListPlaceSelectEvent
class
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
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'] . |
|
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
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. |
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:
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.
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. |