Places Widgets

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
要为其显示自动补全功能的输入元素。
继承的设置componentRestrictionslocationBiaslocationRestrictionrequestedLanguagerequestedRegiontypes
addListener
addListener(eventName, handler)
参数
返回值MapsEventListener
将给定的监听器函数添加到给定的事件名称。
gmp-placeselect
function(place)
参数
当用户选择地点预测时会触发此事件。返回地点对象
gmp-requesterror
function()
参数:None
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此活动不会以气泡形式显示。

PlaceAutocompleteElementOptions 接口

google.maps.places.PlaceAutocompleteElementOptions接口

用于构建 PlaceAutocompleteElement 的选项。

inputElement
要为其显示自动补全功能的输入元素。
componentRestrictions optional
类型ComponentRestrictions optional
组件限制。组件限制用于将预测结果限制为仅父级组件中的预测结果。例如,国家/地区。
element optional
类型HTMLElement|SVGElement optional
此字段为只读字段。支持视图的 DOM 元素。
locationBias optional
类型LocationBias optional
搜索地点时使用的软边界或提示。
locationRestriction optional
类型LocationRestriction optional
用于限制搜索结果的边界。
requestedLanguage optional
类型string optional
返回结果所用语言的语言标识符(如果可能)。系统会以所选语言对搜索结果进行排名,但并不仅限于此语言的建议。请参阅支持的语言列表
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
成功检索到详情后,返回要包含在详情响应中的地点的字段。如需查看字段列表,请参阅 PlaceResult
getPlace
getPlace()
参数:无
返回值PlaceResult 用户选择的地点。
如果成功检索到详细信息,则返回用户选择的地点的详细信息。否则,返回桩地点对象,将 name 属性设置为输入字段的当前值。
setBounds
setBounds(bounds)
参数
返回值:无
设置要在其中返回地点结果的首选区域。结果偏向于(但不限于)该区域。
setComponentRestrictions
setComponentRestrictions(restrictions)
参数
返回值:无
设置组件限制。组件限制用于将预测结果限制为仅父级组件中的预测结果。例如,国家/地区。
setFields
setFields(fields)
参数
  • fieldsArray<string> optional
返回值:无
设置成功检索详情后要包含在详情响应中的地点的字段。如需查看字段列表,请参阅 PlaceResult
setOptions
setOptions(options)
参数
返回值:无
setTypes
setTypes(types)
参数
  • typesArray<string> optional 要包含的预测结果的类型。
返回值:无
设置要返回的预测结果的类型。如需了解支持的类型,请参阅 开发者指南。如果未指定任何类型,系统将返回所有类型。
继承的设置addListenerbindTogetnotifysetsetValuesunbindunbindAll
place_changed
function()
参数:None
当用户为所选地点提供 PlaceResult 时会触发此事件。
如果用户未按控件建议输入地点的名称,然后按 Enter 键,或者如果“地点详情”请求失败,PlaceResult 会在 name 属性中包含用户输入,未定义其他属性。

AutocompleteOptions 接口

google.maps.places.AutocompleteOptions接口

可在 Autocomplete 对象上设置的选项。

bounds optional
用于搜索地点的区域。
componentRestrictions optional
类型ComponentRestrictions optional
组件限制。组件限制用于将预测结果限制为仅父级组件中的预测结果。例如,国家/地区。
fields optional
类型Array<string> optional
成功检索到详情后要添加到详情响应中的地点的字段,系统将根据此字段计费。如果传入 ['ALL'],系统会返回所有可用字段并收取相应费用(不建议用于生产部署)。如需查看字段列表,请参阅 PlaceResult。可以使用字段路径指定嵌套字段(例如 "geometry.location")。默认值为 ['ALL']
placeIdOnly optional
类型boolean optional
是否只检索地点 ID。触发 place_changed 事件后提供的 PlaceResult 将仅包含 place_id、类型和名称字段,以及自动补全服务返回的 place_id、类型和说明。默认情况下,该环境处于停用状态。
strictBounds optional
类型boolean optional
布尔值,表示自动补全 widget 应仅在发送查询时返回位于自动补全 widget 边界内的地点。将 strictBounds 设置为 false(默认值)会使结果偏向于(但不限于)边界中包含的地点。
types optional
类型Array<string> optional
要返回的预测结果类型。如需了解支持的类型,请参阅 开发者指南。如果未指定任何类型,系统将返回所有类型。

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)
参数
返回值:无
设置用于偏向查询预测的区域。搜索结果将仅偏向于此领域,而非完全受限于此领域。
继承的设置addListenerbindTogetnotifysetsetValuesunbindunbindAll
places_changed
function()
参数:None
在用户选择查询时会触发此事件,应使用 getPlaces 获取新的地点。

SearchBoxOptions 接口

google.maps.places.SearchBoxOptions接口

可在 SearchBox 对象上设置的选项。

bounds optional
使查询预测结果偏向于哪个区域。预测结果偏向于不限于基于这些边界的查询。