Places Widgets

PlaceAutocompleteElement 类

google.maps.places.PlaceAutocompleteElement 类

  • PlaceAutocompleteElement 是一个 HTMLElement 子类，可为 Places Autocomplete API 提供界面组件。加载 places 库后，可以在 HTML 中创建具有自动补全功能的输入。例如： 
    <gmp-placeautocomplete ></gmp-placeautocomplete>

自定义元素：
<gmp-placeautocomplete></gmp-placeautocomplete>

此类扩展了 HTMLElement。

此类会实现 PlaceAutocompleteElementOptions。

通过调用 const {PlaceAutocompleteElement} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库。
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
参数：
inputElement
要为其显示自动补全查询的输入元素。
继承：componentRestrictions、locationBias、locationRestriction、requestedLanguage、requestedRegion、types
BetaaddEventListener
addEventListener(type, listener[, options])
参数：
  • type：string 一个区分大小写的字符串，表示要监听的事件类型。
  • listener：EventListener|EventListenerObject 接收通知的对象。此值必须是一个函数或包含 handleEvent 方法的对象
  • options：boolean|AddEventListenerOptions optional 请参阅选项。自定义事件仅支持 capture 和 passive。
返回值：void
设置每当指定事件传送到目标时调用的函数。请参阅 addEventListener。
BetaremoveEventListener
removeEventListener(type, listener[, options])
参数：
返回值：void
从目标中移除之前通过 addEventListener 注册的事件监听器。请参阅 removeEventListener

PlaceAutocompleteElementOptions 接口

google.maps.places.PlaceAutocompleteElementOptions 接口

用于构造 PlaceAutocompleteElement 的选项。
inputElement
要为其显示自动补全查询的输入元素。
componentRestrictions optional
类型：ComponentRestrictions optional
组件限制。组件限制用于将预测结果限制为仅在父组件内进行。例如，国家/地区。
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
要返回的预测类型。如需了解支持的类型，请参阅 开发者指南。如果未指定任何类型，系统将返回所有类型。

PlaceAutocompletePlaceSelectEvent 类

google.maps.places.PlaceAutocompletePlaceSelectEvent 类

此事件在用户使用地点自动补全元素选择地点后创建。使用 event.place 访问所选内容。

此类扩展了 Event。

通过调用 const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库。
Alphaplace
类型：Place

PlaceAutocompleteRequestErrorEvent 类

google.maps.places.PlaceAutocompleteRequestErrorEvent 类

当网络请求存在问题时，PlaceAutocompleteElement 会发出此事件。

此类扩展了 Event。

通过调用 const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库。

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 用户选择的地点。
如果成功检索到详情，则返回用户所选地点的详情。否则，会返回桩 Place 对象，并将 name 属性设置为输入字段的当前值。
setBounds
setBounds(bounds)
参数：
返回值：无
设置要在其中返回地点结果的首选区域。结果偏向于（但不限于）此区域。
setComponentRestrictions
setComponentRestrictions(restrictions)
参数：
返回值：无
设置组件限制。组件限制用于将预测结果限制为仅在父组件内进行。例如，国家/地区。
setFields
setFields(fields)
参数：
  • fields：Array<string> optional
返回值：无
设置成功检索到详情后，要在详情响应中为地点包含的字段。如需查看字段列表，请参阅 PlaceResult。
setOptions
setOptions(options)
参数：
返回值：无
setTypes
setTypes(types)
参数：
  • types：Array<string> optional要包含的预测结果类型。
返回值：无
设置要返回的预测结果类型。如需了解支持的类型，请参阅 开发者指南。如果未指定任何类型，系统将返回所有类型。
继承：addListener、bindTo、get、notify、set、setValues、unbind、unbindAll
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、types 和 name 字段，以及 Autocomplete 服务返回的 place_id、types 和 description。默认情况下，该环境处于停用状态。
strictBounds optional
类型：boolean optional
一个布尔值，表示自动补全 widget 应仅返回发送查询时 Autocomplete 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)
参数：
返回值：无
设置用于自定义调整查询预测的区域。结果只会偏向于此区域，而不会完全局限于此区域。
继承：addListener、bindTo、get、notify、set、setValues、unbind、unbindAll
places_changed
function()
参数：None
当用户选择查询时会触发此事件，应使用 getPlaces 来获取新的地点。

SearchBoxOptions 接口

google.maps.places.SearchBoxOptions 接口

可对 SearchBox 对象设置的选项。
bounds optional
查询预测结果偏向的区域。预测偏向于（但不限于）定位这些边界的查询。