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)
参数
在用户选择地点预测时触发此事件。返回 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
布尔值,表示自动补全微件在发送查询时应仅返回位于自动补全微件边界内的地点。将 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
使预测结果出现偏向的区域。预测结果会偏向于(但不限于)针对这些边界的查询。