PlaceAutocompleteElement 類別
google.maps.places.PlaceAutocompleteElement
class
PlaceAutocompleteElement 是 HTMLElement
子類別,可為 Places Autocomplete API 提供 UI 元件。
PlaceAutocompleteElement 會在內部自動使用 AutocompleteSessionToken
s,將使用者自動完成搜尋的查詢和選取階段歸入不同的工作階段。
對 PlacePrediction.toPlace
傳回的 Place
進行第一次 Place.fetchFields
呼叫時,系統會自動加入用於擷取 PlacePrediction
的工作階段符記。
如要進一步瞭解工作階段的運作方式,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-session-tokens。
自訂元素:
<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>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceAutocompleteElementOptions
。
撥打 const {PlaceAutocompleteElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceAutocompleteElement |
PlaceAutocompleteElement(options) 參數:
|
屬性 | |
---|---|
includedPrimaryTypes |
類型:
Array<string> optional HTML 屬性:
|
includedRegionCodes |
類型:
Array<string> optional 只納入指定區域的結果,最多可指定 15 個 CLDR 雙字元區域代碼。如果集合為空白,系統不會限制結果。如果同時設定
locationRestriction 和 includedRegionCodes ,結果會位於交集區域。HTML 屬性:
|
locationBias |
類型:
LocationBias optional 搜尋地點時使用的軟性邊界或提示。 |
locationRestriction |
類型:
LocationRestriction optional 用來限制搜尋結果的範圍。 |
name |
類型:
string optional 輸入元素要使用的名稱。詳情請參閱 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name。與輸入內容的名稱屬性行為相同。請注意,提交表單時會使用這個名稱。詳情請參閱 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form。
HTML 屬性:
|
origin |
類型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional 計算距離的起點。如未指定,系統就不會計算距離。系統不會使用海拔高度 (如有) 進行計算。
HTML 屬性:
|
requestedLanguage |
類型:
string optional 盡可能提供語言 ID,指出應以哪種語言傳回結果。系統可能會優先顯示所選語言的結果,但建議不限於該語言。請參閱支援語言清單。
HTML 屬性:
|
requestedRegion |
類型:
string optional 用於格式化和篩選結果的區域代碼。這不會將建議限制在該國家/地區。區碼接受 ccTLD (「頂層網域」) 的兩位字元值。多數 ccTLD 代碼與 ISO 3166-1 代碼相同,只有少數例外。舉例來說,英國的 ccTLD 是「uk」(
.co.uk ),而 ISO 3166-1 代碼是「gb」(技術上是指「大不列顛及北愛爾蘭聯合王國」實體)。HTML 屬性:
|
unitSystem |
類型:
UnitSystem optional 顯示距離時使用的單位制。如未指定,系統會根據 requestedRegion 決定單位系統。
HTML 屬性:
|
零件 | |
---|---|
prediction-item |
預測下拉式選單中的項目,代表單一預測。 |
prediction-item-icon |
顯示在預測查詢字串清單中每個項目左側的圖示。 |
prediction-item-main-text |
預測項目的一部分,是預測結果的主要文字。就地理位置而言,這包含地方資訊名稱 (例如「Sydney」) 或街道名稱及門牌號碼 (例如「10 King Street」)。預設情況下,prediction-item-main-text 為黑色。如果預測項目中有任何額外文字,則會位於 prediction-item-main-text 之外,並沿用 prediction-item 的樣式。在預設情況下會以灰色顯示。這組額外文字通常是地址。 |
prediction-item-match |
傳回的預測查詢字串中,與使用者輸入文字相符的部分。根據預設,這組相符文字會以粗體字標示。請注意,相符文字可能會在 prediction-item 內的任何位置,不一定是 prediction-item-main-text 的一部分。 |
prediction-item-selected |
使用者透過鍵盤導覽至的項目。注意:選取的項目會受到這部分樣式和預測項目部分樣式的影響。 |
prediction-list |
包含「地方資訊自動完成」服務所傳回預測查詢字串清單的視覺元素。這份清單會以下拉式選單的形式,顯示在 PlaceAutocompleteElement 下方。 |
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
事件 | |
---|---|
gmp-error |
function(errorEvent) 引數:
當後端要求遭到拒絕時 (例如 API 金鑰不正確),就會觸發這項事件。這個事件不會冒泡。 |
gmp-select |
function(placePredictionSelectEvent) 引數:
使用者選取地點預測時,系統會觸發這項事件。內含可轉換為 Place 物件的 PlacePrediction 物件。 |
PlaceAutocompleteElementOptions interface
google.maps.places.PlaceAutocompleteElementOptions
介面
建構 PlaceAutocompleteElement 的選項。如要瞭解各項屬性,請參閱 PlaceAutocompleteElement 類別中同名的屬性。
屬性 | |
---|---|
locationBias optional |
類型:
LocationBias optional |
locationRestriction optional |
類型:
LocationRestriction optional |
name optional |
類型:
string optional |
requestedLanguage optional |
類型:
string optional |
PlacePredictionSelectEvent class
google.maps.places.PlacePredictionSelectEvent
class
使用者透過 PlaceAutocompleteElement 選取預測項目後,系統就會建立這個事件。使用 event.placePrediction
存取選取範圍。
呼叫 PlacePrediction.toPlace
,將 placePrediction 轉換為 Place
。
這個類別會擴充 Event
。
撥打 const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
---|---|
placePrediction |
類型:
PlacePrediction 呼叫 PlacePrediction.toPlace 將其轉換為 Place 。 |
PlaceAutocompleteRequestErrorEvent class
google.maps.places.PlaceAutocompleteRequestErrorEvent
class
網路要求發生問題時,PlaceAutocompleteElement 會發出這個事件。
這個類別會擴充 Event
。
撥打 const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
PlaceContextualElement class
google.maps.places.PlaceContextualElement
class
這個小工具會使用情境權杖,顯示 Grounding with Google Maps 回應的情境檢視畫面。
自訂元素:
<gmp-place-contextual context-token="string"></gmp-place-contextual>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceContextualElementOptions
。
撥打 const {PlaceContextualElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
---|---|
contextToken |
類型:
string optional 內容權杖。
HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceContextualElementOptions interface
google.maps.places.PlaceContextualElementOptions
介面
「PlaceContextualElement
」的選項。
屬性 | |
---|---|
contextToken optional |
類型:
string optional Grounding with Google Maps 回應提供的內容權杖。 |
PlaceContextualListConfigElement class
google.maps.places.PlaceContextualListConfigElement
class
HTML 元素,可設定地點情境元素清單檢視畫面的選項。
自訂元素:
<gmp-place-contextual-list-config layout="compact" map-hidden></gmp-place-contextual-list-config>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceContextualListConfigElementOptions
。
撥打 const {PlaceContextualListConfigElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
---|---|
layout |
類型:
PlaceContextualListLayout optional 版面配置。
HTML 屬性:
|
mapHidden |
類型:
boolean optional 地圖是否隱藏。
HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceContextualListConfigElementOptions 介面
google.maps.places.PlaceContextualListConfigElementOptions
介面
PlaceContextualListConfigElement 的選項。
屬性 | |
---|---|
layout optional |
類型:
PlaceContextualListLayout optional 版面配置。預設值為 PlaceContextualListLayout.VERTICAL 。 |
mapHidden optional |
類型:
boolean optional 地圖是否隱藏。預設值為顯示地圖 (值為 false)。 |
PlaceContextualListLayout 常數
google.maps.places.PlaceContextualListLayout
常數
地點內容元素支援清單檢視畫面的版面配置清單。
撥打 const {PlaceContextualListLayout} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
---|---|
COMPACT |
精簡清單版面配置:清單項目會以單行連結的形式呈現,溢出的項目則會顯示在下拉式清單中。 |
VERTICAL |
直向清單版面配置:清單項目會以直向清單中的資訊卡形式呈現。 |
PlaceDetailsElement class
google.maps.places.PlaceDetailsElement
class
顯示地點詳細資料的 HTML 元素。使用 configureFromPlace()
或 configureFromLocation()
方法指定要算繪的內容。如要使用地點詳細資料元素,請在 Google Cloud 控制台中,為專案啟用 Places UI Kit API。
自訂元素:
<gmp-place-details size="small"></gmp-place-details>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceDetailsElementOptions
。
撥打 const {PlaceDetailsElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceDetailsElement |
PlaceDetailsElement([options]) 參數:
|
屬性 | |
---|---|
place |
類型:
Place optional 僅供檢視。 Place 物件,內含目前算繪地點的 ID、位置和可視區域。 |
size |
類型:
PlaceDetailsSize optional PlaceDetailsElement 的大小變體。根據預設,元素會顯示
PlaceDetailsSize.X_LARGE 。HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
configureFromLocation |
configureFromLocation(location) 參數:
傳回值:
Promise<void> 載入及算繪地點資料後,系統會解析 Promise。使用反向地理編碼,從 LatLng 設定小工具。 |
configureFromPlace |
configureFromPlace(place) 參數:
傳回值:
Promise<void> 載入及算繪地點資料後,系統會解析 Promise。透過 Place 物件或地點 ID 設定小工具。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
事件 | |
---|---|
gmp-load |
function(event) 引數:
當元素載入並算繪內容時,系統會觸發這個事件。這個事件不會冒泡。 |
gmp-requesterror |
function(event) 引數:
當後端要求遭到拒絕時 (例如 API 金鑰不正確),就會觸發這項事件。這個事件不會冒泡。 |
PlaceDetailsElementOptions interface
google.maps.places.PlaceDetailsElementOptions
介面
「PlaceDetailsElement
」的選項。
屬性 | |
---|---|
size optional |
類型:
PlaceDetailsSize optional |
PlaceDetailsSize 常數
google.maps.places.PlaceDetailsSize
常數
PlaceDetailsElement
的尺寸子類。
撥打 const {PlaceDetailsSize} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
---|---|
LARGE |
大型變體,包括大型圖片、基本資訊和聯絡資訊。 |
MEDIUM |
中型變體,包含大型圖片和基本資訊。 |
SMALL |
小型變化版本,包含小型圖片和基本資訊。 |
X_LARGE |
特大變體,包括相片集錦、評論和詳細地點資訊。 |
PlaceDetailsCompactElement class
google.maps.places.PlaceDetailsCompactElement
class
以精簡版面配置顯示地點詳細資料。附加 PlaceDetailsPlaceRequestElement
,指定要轉譯的地點。附加 PlaceContentConfigElement
、PlaceStandardContentElement
或 PlaceAllContentElement
,指定要算繪的內容。
如要使用這個元素,請在 Google Cloud 控制台中為專案啟用 Places UI Kit API。
自訂元素:
<gmp-place-details-compact orientation="vertical" truncation-preferred></gmp-place-details-compact>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceDetailsCompactElementOptions
。
撥打 const {PlaceDetailsCompactElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceDetailsCompactElement |
PlaceDetailsCompactElement([options]) 參數:
|
屬性 | |
---|---|
orientation |
類型:
PlaceDetailsOrientation optional 預設值:
PlaceDetailsOrientation.VERTICAL 元素的方向變體 (垂直或水平)。
HTML 屬性:
|
place |
類型:
Place optional 僅供檢視。Place 物件,內含目前算繪地點的 ID、位置和可視區域。 |
truncationPreferred |
類型:
boolean 預設值:
false 如果為 true,系統會截斷地點名稱和地址,以符合單行顯示空間,而不是換行。
HTML 屬性:
|
CSS 屬性 | |
---|---|
--gmp-mat-color-info |
具有資訊情緒的 UI 元素顏色。用於輪椅圖示。 |
--gmp-mat-color-negative |
情緒負面的 UI 元素顏色。用於「現在營業中」狀態的「已關閉」文字。 |
--gmp-mat-color-neutral-container |
中性填滿 UI 元素的容器顏色。用於圖片預留位置。 |
--gmp-mat-color-on-secondary-container |
文字和圖示的顏色,與次要容器顏色形成對比。用於「在 Google 地圖中開啟」按鈕上的文字和圖示。 |
--gmp-mat-color-on-surface |
文字和圖示在任何介面顏色上的顏色。用於一般文字。 |
--gmp-mat-color-on-surface-variant |
在任何介面顏色上,文字和圖示的低強調色。用於較不強調的文字。 |
--gmp-mat-color-outline-decorative |
非互動式元素的外框顏色。用於元素邊框。 |
--gmp-mat-color-positive |
情緒正向的 UI 元素顏色。用於「營業中」狀態中的「營業中」文字。 |
--gmp-mat-color-primary |
互動式文字和圖示的顏色,與介面顏色形成對比。用於歸因對話方塊中的評論數和連結。 |
--gmp-mat-color-secondary-container |
相較於表面,填滿顏色較不顯眼,適用於色調按鈕等隱性元件。用於「在 Google 地圖中開啟」按鈕的背景。 |
--gmp-mat-color-surface |
背景顏色。用於元素和出處對話方塊的背景。 |
--gmp-mat-font-body-medium |
用於出處對話方塊中的內文。 |
--gmp-mat-font-body-small |
用於地點地址、評分、類型、價格和目前營業狀態。 |
--gmp-mat-font-family |
用於所有文字的基本字型系列。 |
--gmp-mat-font-headline-medium |
用於歸因對話方塊中的標題文字。 |
--gmp-mat-font-label-large |
用於「在 Google 地圖中開啟」按鈕和出處資訊對話方塊中的連結。 |
--gmp-mat-font-title-small |
用於地點名稱。 |
background-color |
覆寫元素的背景顏色。 |
border |
覆寫元素的邊框。 |
border-radius |
覆寫元素的邊框半徑。 |
color-scheme |
|
font-size |
縮放元素中的所有文字和圖示,這些項目在內部是以 em 為單位定義。預設值為 16px 。 |
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
事件 | |
---|---|
gmp-error |
function(event) 引數:
當後端要求遭到拒絕時 (例如 API 金鑰不正確),就會觸發這項事件。這個事件不會冒泡。 |
gmp-load |
function(event) 引數:
當元素載入並算繪內容時,系統會觸發這個事件。這個事件不會冒泡。 |
PlaceDetailsCompactElementOptions interface
google.maps.places.PlaceDetailsCompactElementOptions
介面
「PlaceDetailsCompactElement
」的選項。
屬性 | |
---|---|
orientation optional |
類型:
PlaceDetailsOrientation optional |
truncationPreferred optional |
類型:
boolean optional |
PlaceDetailsOrientation 常數
google.maps.places.PlaceDetailsOrientation
常數
「PlaceDetailsCompactElement
」的螢幕方向變體。
撥打 const {PlaceDetailsOrientation} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
---|---|
HORIZONTAL |
橫向。 |
VERTICAL |
直向。 |
PlaceDetailsPlaceRequestElement 類別
google.maps.places.PlaceDetailsPlaceRequestElement
class
設定 Place Details Compact 元素,根據地點物件、ID 或資源名稱載入資料。將這個元素附加為 PlaceDetailsCompactElement
的子項,即可載入指定地點的資料。
自訂元素:
<gmp-place-details-place-request place="some-place-id"></gmp-place-details-place-request>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceDetailsPlaceRequestElementOptions
。
撥打 const {PlaceDetailsPlaceRequestElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceDetailsPlaceRequestElement |
PlaceDetailsPlaceRequestElement([options]) 參數:
|
屬性 | |
---|---|
place |
類型:
Place optional 要在 Place Details Compact 元素中顯示詳細資料的地點物件、ID 或資源名稱。這項屬性會以資源名稱的形式反映至屬性。
HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceDetailsPlaceRequestElementOptions interface
google.maps.places.PlaceDetailsPlaceRequestElementOptions
介面
「PlaceDetailsPlaceRequestElement
」的選項。
屬性 | |
---|---|
place optional |
類型:
Place|string optional |
PlaceContentConfigElement class
google.maps.places.PlaceContentConfigElement
class
設定 Place Details Compact 元素顯示的內容。將這個元素附加為 PlaceDetailsCompactElement
的子項,即可使用。在 PlaceContentConfigElement
中附加下列任一元素,即可顯示對應內容:
PlaceMediaElement
、PlaceAddressElement
、PlaceRatingElement
、PlaceTypeElement
、PlacePriceElement
、PlaceAccessibleEntranceIconElement
、PlaceOpenNowStatusElement
、PlaceAttributionElement
子項的順序並不重要,元素會以標準順序算繪內容,且無法自訂。
自訂元素:
<gmp-place-content-config></gmp-place-content-config>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceContentConfigElementOptions
。
撥打 const {PlaceContentConfigElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceContentConfigElement |
PlaceContentConfigElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceContentConfigElementOptions interface
google.maps.places.PlaceContentConfigElementOptions
介面
「PlaceContentConfigElement
」的選項。
PlaceMediaElement class
google.maps.places.PlaceMediaElement
class
設定 Place Details Compact 元素,顯示地點的媒體 (例如相片)。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-media lightbox-preferred></gmp-place-media>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceMediaElementOptions
。
撥打 const {PlaceMediaElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceMediaElement |
PlaceMediaElement([options]) 參數:
|
屬性 | |
---|---|
lightboxPreferred |
類型:
boolean optional 預設值:
false 是否啟用或停用媒體燈箱 (如果兩者都支援)。
HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceMediaElementOptions 介面
google.maps.places.PlaceMediaElementOptions
介面
「PlaceMediaElement
」的選項。
屬性 | |
---|---|
lightboxPreferred optional |
類型:
boolean optional |
PlaceAddressElement class
google.maps.places.PlaceAddressElement
class
設定 Place Details Compact 元素,顯示地點的地址。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-address></gmp-place-address>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceAddressElementOptions
。
撥打 const {PlaceAddressElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceAddressElement |
PlaceAddressElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceAddressElementOptions 介面
google.maps.places.PlaceAddressElementOptions
介面
「PlaceAddressElement
」的選項。
PlaceRatingElement class
google.maps.places.PlaceRatingElement
class
設定 Place Details Compact 元素,顯示地點的評分。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-rating></gmp-place-rating>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceRatingElementOptions
。
撥打 const {PlaceRatingElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceRatingElement |
PlaceRatingElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceRatingElementOptions interface
google.maps.places.PlaceRatingElementOptions
介面
「PlaceRatingElement
」的選項。
PlaceTypeElement class
google.maps.places.PlaceTypeElement
class
設定 Place Details Compact 元素,顯示地點類型。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-type></gmp-place-type>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceTypeElementOptions
。
撥打 const {PlaceTypeElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceTypeElement |
PlaceTypeElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlacePriceElement class
google.maps.places.PlacePriceElement
class
設定 Place Details Compact 元素,顯示地點的價格等級或價格範圍。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-price></gmp-place-price>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlacePriceElementOptions
。
撥打 const {PlacePriceElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlacePriceElement |
PlacePriceElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceAccessibleEntranceIconElement class
google.maps.places.PlaceAccessibleEntranceIconElement
class
設定地點詳細資料精簡元素,在地點設有無障礙入口時顯示輪椅圖示。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-accessible-entrance-icon></gmp-place-accessible-entrance-icon>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceAccessibleEntranceIconElementOptions
。
撥打 const {PlaceAccessibleEntranceIconElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceAccessibleEntranceIconElement |
PlaceAccessibleEntranceIconElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceAccessibleEntranceIconElementOptions 介面
google.maps.places.PlaceAccessibleEntranceIconElementOptions
介面
「PlaceAccessibleEntranceIconElement
」的選項。
PlaceOpenNowStatusElement class
google.maps.places.PlaceOpenNowStatusElement
class
設定 Place Details Compact 元素,顯示地點目前的營業或關閉狀態。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。
自訂元素:
<gmp-place-open-now-status></gmp-place-open-now-status>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceOpenNowStatusElementOptions
。
撥打 const {PlaceOpenNowStatusElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceOpenNowStatusElement |
PlaceOpenNowStatusElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceOpenNowStatusElementOptions interface
google.maps.places.PlaceOpenNowStatusElementOptions
介面
「PlaceOpenNowStatusElement
」的選項。
PlaceAttributionElement class
google.maps.places.PlaceAttributionElement
class
可自訂 Place Details Compact 元素中的 Google 地圖出處文字。將這個元素附加為 PlaceContentConfigElement
的子項,即可使用。如果省略這個元素,系統仍會顯示出處資訊,但會使用預設顏色。
自訂元素:
<gmp-place-attribution dark-scheme-color="white" light-scheme-color="white"></gmp-place-attribution>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceAttributionElementOptions
。
撥打 const {PlaceAttributionElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceAttributionElement |
PlaceAttributionElement([options]) 參數:
|
屬性 | |
---|---|
darkSchemeColor |
類型:
AttributionColor optional 預設值:
AttributionColor.WHITE 深色模式下 Google 地圖出處資訊的顏色。
HTML 屬性:
|
lightSchemeColor |
類型:
AttributionColor optional 預設值:
AttributionColor.GRAY 淺色模式下 Google 地圖出處資訊的顏色。
HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceAttributionElementOptions 介面
google.maps.places.PlaceAttributionElementOptions
介面
「PlaceAttributionElement
」的選項。
屬性 | |
---|---|
darkSchemeColor optional |
類型:
AttributionColor optional |
lightSchemeColor optional |
類型:
AttributionColor optional |
AttributionColor 常數
google.maps.places.AttributionColor
常數
Google 地圖出處註明文字的顏色選項。您可以自訂出處,使用上述任一顏色。
撥打 const {AttributionColor} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
---|---|
BLACK |
黑色作者資訊文字。 |
GRAY |
灰色的出處資訊文字。 |
WHITE |
白色作者資訊文字。 |
PlaceAllContentElement class
google.maps.places.PlaceAllContentElement
class
設定 Place Details Compact 元素,顯示所有可用內容。將這個元素附加為 PlaceDetailsCompactElement
的子項,即可使用。
自訂元素:
<gmp-place-all-content></gmp-place-all-content>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceAllContentElementOptions
。
撥打 const {PlaceAllContentElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceAllContentElement |
PlaceAllContentElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceAllContentElementOptions 介面
google.maps.places.PlaceAllContentElementOptions
介面
「PlaceAllContentElement
」的選項。
PlaceStandardContentElement class
google.maps.places.PlaceStandardContentElement
class
設定「地點詳細資料精簡」元素,顯示標準內容集 (媒體、評分、類型、價格、無障礙入口圖示和營業中狀態)。將這個元素附加為 PlaceDetailsCompactElement
的子項,即可使用。
自訂元素:
<gmp-place-standard-content></gmp-place-standard-content>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceStandardContentElementOptions
。
撥打 const {PlaceStandardContentElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceStandardContentElement |
PlaceStandardContentElement([options]) 參數:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
PlaceStandardContentElementOptions interface
google.maps.places.PlaceStandardContentElementOptions
介面
「PlaceStandardContentElement
」的選項。
PlaceListElement class
google.maps.places.PlaceListElement
class
HTML 元素,可將地點搜尋結果顯示在清單中。使用 configureFromSearchByTextRequest()
或 configureFromSearchNearbyRequest()
方法,指定要用於顯示結果的要求。如要使用地點清單元素,請在 Google Cloud 控制台中,為專案啟用 Places UI Kit API。
自訂元素:
<gmp-place-list selectable></gmp-place-list>
這個類別會擴充 HTMLElement
。
這個類別會實作 PlaceListElementOptions
。
撥打 const {PlaceListElement} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
PlaceListElement |
PlaceListElement([options]) 參數:
|
屬性 | |
---|---|
places |
僅供檢視。 Place 物件陣列,內含目前算繪地點的 ID、位置和檢視區塊。 |
selectable |
類型:
boolean 清單項目是否可選取。如果為 true,清單項目會是按鈕,點按時會分派
gmp-placeselect 事件。也支援無障礙鍵盤導覽和選取功能。HTML 屬性:
|
方法 | |
---|---|
|
addEventListener(type, listener[, options]) 參數:
傳回值:
void 設定函式,每當指定事件傳送至目標時,系統就會呼叫該函式。請參閱 addEventListener。 |
configureFromSearchByTextRequest |
configureFromSearchByTextRequest(request) 參數:
傳回值:
Promise<void> 載入及算繪地點資料後,系統會解析 Promise。設定小工具,以便從 Places Text Search API 要求算繪搜尋結果。 |
configureFromSearchNearbyRequest |
configureFromSearchNearbyRequest(request) 參數:
傳回值:
Promise<void> 載入及算繪地點資料後,系統會解析 Promise。設定小工具,以便從 Places Nearby Search API 要求轉譯搜尋結果。 |
|
removeEventListener(type, listener[, options]) 參數:
傳回值:
void 從目標中移除先前透過 addEventListener 註冊的事件監聽器。請參閱「removeEventListener」。 |
事件 | |
---|---|
gmp-load |
function(event) 引數:
當元素載入並算繪內容時,系統會觸發這個事件。這個事件不會冒泡。 |
gmp-placeselect |
function(event) 引數:
使用者選取地點時,系統會觸發這項事件。包含 Place 物件和清單中所選地點的索引。 |
gmp-requesterror |
function(event) 引數:
當後端要求遭到拒絕時 (例如 API 金鑰不正確),就會觸發這項事件。這個事件不會冒泡。 |
PlaceListElementOptions interface
google.maps.places.PlaceListElementOptions
介面
「PlaceListElement
」的選項。
屬性 | |
---|---|
selectable optional |
類型:
boolean optional |
PlaceListPlaceSelectEvent 類別
google.maps.places.PlaceListPlaceSelectEvent
class
使用者選取地點時,PlaceListElement
會發出這個事件。
這個類別會擴充 Event
。
撥打 const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
---|---|
index |
類型:
number 所選地點的清單索引。 |
place |
類型:
Place Place 物件,內含所選地點的 ID、位置和可視區域。 |
自動完成 類別
google.maps.places.Autocomplete
class
這個小工具會根據使用者輸入的文字提供地點預測結果。這個指令會附加至 text
類型的輸入元素,並監聽該欄位中的文字輸入內容。預測結果清單會以下拉式清單的形式顯示,並在輸入文字時更新。
這個類別會擴充 MVCObject
。
撥打 const {Autocomplete} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
Autocomplete |
Autocomplete(inputField[, opts]) 參數:
建立 Autocomplete 的新例項,並使用指定選項附加至指定輸入文字欄位。 |
方法 | |
---|---|
getBounds |
getBounds() 參數:無
傳回值:
LatLngBounds|undefined 偏差界限。傳回預測結果的偏誤範圍。 |
getFields |
getFields() 參數:無
傳回值:
Array<string>|undefined 成功擷取詳細資料時,傳回要在詳細資料回應中納入的 Place 欄位。如需欄位清單,請參閱 PlaceResult 。 |
getPlace |
getPlace() 參數:無
傳回值:
PlaceResult 使用者選取的地點。如果成功擷取詳細資料,系統會傳回使用者選取的地點詳細資料。否則會傳回 Place 物件的存根,並將 name 屬性設為輸入欄位的目前值。 |
setBounds |
setBounds(bounds) 參數:
傳回值:無
設定要傳回地點結果的偏好區域。結果可能會優先 (但不限於) 顯示這個區域的地點。 |
setComponentRestrictions |
setComponentRestrictions(restrictions) 參數:
傳回值:無
設定元件限制。元件限制用於將預測結果限制在父項元件內。例如國家/地區。 |
setFields |
setFields(fields) 參數:
傳回值:無
設定成功擷取詳細資料時,要在詳細資料回應中納入的地點欄位。如需欄位清單,請參閱 PlaceResult 。 |
setOptions |
setOptions(options) 參數:
傳回值:無
|
setTypes |
setTypes(types) 參數:
傳回值:無
設定要傳回的預測類型。如要瞭解支援的類型,請參閱 開發人員指南。如果未指定類型,系統會傳回所有類型。 |
已繼承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
事件 | |
---|---|
place_changed |
function() 引數:無
當使用者選取的地點提供 PlaceResult 時,系統會觸發這項事件。如果使用者輸入控制項未建議的地點名稱並按下 Enter 鍵,或地點詳細資料要求失敗,則 PlaceResult 會在 name 屬性中包含使用者輸入的內容,且未定義其他屬性。 |
AutocompleteOptions 介面
google.maps.places.AutocompleteOptions
介面
可在 Autocomplete
物件上設定的選項。
屬性 | |
---|---|
bounds optional |
類型:
LatLngBounds|LatLngBoundsLiteral optional 要搜尋地點的區域。 |
componentRestrictions optional |
類型:
ComponentRestrictions optional 元件限制。元件限制用於將預測結果限制在父項元件內。例如國家/地區。 |
fields optional |
類型:
Array<string> optional 成功擷取詳細資料時,詳細資料回應中要納入的 Place 欄位,這些欄位會產生費用。如果傳入 ['ALL'] ,系統會傳回所有可用的欄位並據此收費 (不適用於實際工作環境部署作業)。如需欄位清單,請參閱 PlaceResult 。您可以使用點路徑指定巢狀欄位 (例如 "geometry.location" )。預設值為 ['ALL'] 。 |
|
類型:
boolean optional 是否只擷取地點 ID。系統觸發 place_changed 事件時,可用的 PlaceResult 只會包含 place_id、types 和 name 欄位,以及 Autocomplete 服務傳回的 place_id、types 和 description。預設為停用。 |
strictBounds optional |
類型:
boolean optional 布林值,表示 Autocomplete 小工具只能傳回查詢當下位於小工具界線內的地點。將 strictBounds 設為 false (預設值) 時,結果可能會優先 (但不限於) 顯示邊界內的地點。 |
types optional |
類型:
Array<string> optional 要傳回的預測類型。如要瞭解支援的類型,請參閱 開發人員指南。如果未指定類型,系統會傳回所有類型。 |
SearchBox class
google.maps.places.SearchBox
class
這個小工具會根據使用者輸入的文字提供查詢預測。這個指令會附加至 text
類型的輸入元素,並監聽該欄位中的文字輸入內容。預測結果清單會以下拉式清單的形式顯示,並在輸入文字時更新。
這個類別會擴充 MVCObject
。
撥打 const {SearchBox} = await google.maps.importLibrary("places")
即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
建構函式 | |
---|---|
SearchBox |
SearchBox(inputField[, opts]) 參數:
建立 SearchBox 的新例項,並使用指定選項附加至指定輸入文字欄位。 |
方法 | |
---|---|
getBounds |
getBounds() 參數:無
傳回值:
LatLngBounds|undefined 傳回查詢預測結果的偏誤範圍。 |
getPlaces |
getPlaces() 參數:無
傳回值:
Array<PlaceResult>|undefined 傳回使用者選取的查詢,用於 places_changed 事件。 |
setBounds |
setBounds(bounds) 參數:
傳回值:無
設定用於查詢預測偏誤的區域。結果只會優先顯示這個區域的地點,但不會完全限制於此。 |
已繼承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
事件 | |
---|---|
places_changed |
function() 引數:無
使用者選取查詢時會觸發此事件, getPlaces 則用於取得新地點。 |
SearchBoxOptions interface
google.maps.places.SearchBoxOptions
介面
可在 SearchBox
物件上設定的選項。
屬性 | |
---|---|
bounds optional |
類型:
LatLngBounds|LatLngBoundsLiteral optional 要將查詢預測結果偏向的區域。預測結果可能會優先 (但不限於) 顯示這些邊界內的地點。 |