PlaceAutocompleteElement 類別
google.maps.places.PlaceAutocompleteElement
類別
導入 Places API 的 AutocompleteView
這個類別會實作 PlaceAutocompleteElementOptions
。
呼叫 const {PlaceAutocompleteElement} = await google.maps.importLibrary("places")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
建構函式 | |
---|---|
PlaceAutocompleteElement |
PlaceAutocompleteElement(options) 參數:
|
屬性 | |
---|---|
element optional |
類型:
HTMLElement|SVGElement optional 這個欄位處於唯讀狀態。支援檢視畫面的 DOM 元素。 |
inputElement |
類型:
HTMLInputElement 要顯示自動完成建議的輸入元素。 |
沿用於:
componentRestrictions 、locationBias 、locationRestriction 、requestedLanguage 、requestedRegion 、types |
方法 | |
---|---|
addListener |
addListener(eventName, handler) 參數:
傳回價值:
MapsEventListener 將指定事件監聽器函式新增至指定事件名稱。 |
事件 | |
---|---|
gmp-placeselect |
function(place) 引數:
使用者選取地點預測結果時,系統會觸發這個事件。傳回 Place 物件。 |
gmp-requesterror |
function() 引數:無
當對後端的要求遭拒時 (例如 API 金鑰不正確),就會觸發這個事件。這個活動不會以對話框形式顯示。 |
PlaceAutocompleteElementOptions 介面
google.maps.places.PlaceAutocompleteElementOptions
介面
用於建構 PlaceAutocompleteElement 的選項。
屬性 | |
---|---|
inputElement |
類型:
HTMLInputElement 要顯示自動完成建議的輸入元素。 |
componentRestrictions optional |
類型:
ComponentRestrictions optional 元件限制。元件限制僅用於將預測結果限制在父項元件中。例如國家/地區。 |
element optional |
類型:
HTMLElement|SVGElement optional 這個欄位處於唯讀狀態。支援檢視畫面的 DOM 元素。 |
locationBias optional |
類型:
LocationBias optional 搜尋地點時使用的柔軟界線。 |
locationRestriction optional |
類型:
LocationRestriction optional 要限制搜尋結果的邊界。 |
requestedLanguage optional |
類型:
string optional 要傳回結果的語言語言 ID (如果可能的話)。所選語言的結果可能會獲得較高的排名,但建議可能不受此語言限制。請參閱支援語言清單。 |
requestedRegion optional |
類型:
string optional 用於結果格式和結果篩選的區碼。但不會限制這個國家/地區的建議。區碼可接受 ccTLD (「頂層網域」) 兩位字元值。多數 ccTLD 代碼與 ISO 3166-1 代碼相同,只有少數例外。舉例來說,英國的 ccTLD 是「uk」( .co.uk ),而 ISO 3166-1 代碼卻是「gb」(嚴格來說是「英國和北愛爾蘭」的實體)。 |
types optional |
類型:
Array<string> optional 要傳回的預測類型。如需支援的類型,請參閱 開發人員指南。如果沒有指定類型,系統就會傳回所有類型。 |
Autocomplete 類別
google.maps.places.Autocomplete
類別
小工具可根據使用者的文字輸入內容,提供地點預測結果。這會附加至 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 Details 中要包含的欄位。如需欄位清單,請參閱 PlaceResult 。 |
getPlace |
getPlace() 參數:無
回傳值:
PlaceResult 使用者選取的地點。如果成功擷取詳細資料,則傳回使用者選取的地點詳細資料。否則會傳回虛設常式地點物件,並將 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 鍵,或是 Place Details 要求失敗, PlaceResult 會包含 name 屬性中的使用者輸入內容,但不會定義任何其他屬性。 |
AutocompleteOptions 介面
google.maps.places.AutocompleteOptions
介面
可在 Autocomplete
物件上設定的選項。
屬性 | |
---|---|
bounds optional |
類型:
LatLngBounds|LatLngBoundsLiteral optional 地點搜尋區域。 |
componentRestrictions optional |
類型:
ComponentRestrictions optional 元件限制。元件限制僅用於將預測結果限制在父項元件中。例如國家/地區。 |
fields optional |
類型:
Array<string> optional 成功擷取詳細資料時,要納入詳細資料回應中的欄位,會產生費用。如果傳入 ['ALL'] ,則系統會傳回所有可用的欄位並向您收費 (不適用於實際工作環境部署作業)。如需欄位清單,請參閱 PlaceResult 。巢狀點欄位可以用點路徑 (例如 "geometry.location" ) 指定,預設值為 ['ALL'] 。 |
|
類型:
boolean optional 是否只擷取地點 ID。觸發 place_changed 事件時可用的 PlaceResult 只會有 place_id、type 和 name 欄位,以及 Place Service 傳回的 place_id、類型及說明。預設為停用。 |
strictBounds optional |
類型:
boolean optional 布林值,表示「自動完成」小工具只應在傳送時,在 Autocomplete 小工具的邊界內傳回這些地點。將 strictBounds 設為 false (此為預設) 會使結果偏誤 (但不限於) 落在邊界內的地點。 |
types optional |
類型:
Array<string> optional 要傳回的預測類型。如需支援的類型,請參閱 開發人員指南。如果沒有指定類型,系統就會傳回所有類型。 |
SearchBox 類別
google.maps.places.SearchBox
類別
可根據使用者輸入內容輸入內容提供預測功能的小工具。這會附加至 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 介面
google.maps.places.SearchBoxOptions
介面
可在 SearchBox
物件上設定的選項。
屬性 | |
---|---|
bounds optional |
類型:
LatLngBounds|LatLngBoundsLiteral optional 用於調整查詢預測的區域。預測功能會優先鎖定這些目標,包括但不限於指定這些查詢的查詢。 |