PlaceAutocompleteElement 类
class
google.maps.places.PlaceAutocompleteElement
extends HTMLElement
implements PlaceAutocompleteElementOptions
library "places"
PlaceAutocompleteElement 是 HTMLElement 子类,可为 Places 地点自动补全 API 提供界面组件。
PlaceAutocompleteElement 会自动在内部使用 AutocompleteSessionToken,将用户自动补全搜索的查询和选择阶段归入不同的会话。
首次对 PlacePrediction.toPlace 返回的 Place 调用 Place.fetchFields 时,系统会自动添加用于提取 PlacePrediction 的会话令牌。
如需详细了解会话令牌的工作原理,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-session-tokens。
<gmp-place-autocomplete description="string" disabled future-opening-businesses-included included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." internal-usage-attribution-ids="space separated strings" maxlength="number" name="string" no-clear-button no-input-icon origin="lat,lng" placeholder="string" pure-service-area-businesses-included readonly requested-language="string" requested-region="string" unit-system="value-name"> </gmp-place-autocomplete>
const {PlaceAutocompleteElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceAutocompleteElement |
PlaceAutocompleteElement([options])参数:
|
属性 | |
|---|---|
description
attr: description |
类型:
string optional要用于输入元素的说明。当输入元素获得焦点时,屏幕阅读器会检测到此属性。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby。
HTML 属性: description="string" |
disabled
attr: disabled |
输入类型:
boolean optional输出类型: boolean输入元素是否已停用。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#disabled。
HTML 属性: disabled |
futureOpeningBusinessesIncluded
attr: future-opening-businesses-included |
类型:
boolean optional是否包含尚未开业但预计未来会开业的地点。
HTML 属性: future-opening-businesses-included |
includedPrimaryTypes
attr: included-primary-types |
类型:
Array<string> optional包含的主要地点类型(例如“restaurant”或“gas_station”)。
只有在地点的主要类型包含在此列表中时,系统才会返回该地点。最多可以指定 5 个值。如果未指定任何类型,系统将返回所有地点类型。 HTML 属性: included-primary-types="type1 type2 type3..." |
includedRegionCodes
attr: included-region-codes |
类型:
Array<string> optional仅包含指定区域的结果,最多可指定 15 个 CLDR 双字符区域代码。空集不会限制结果。如果同时设置了
locationRestriction 和 includedRegionCodes,则结果将位于交集区域。HTML 属性: included-region-codes="c1 c2 c3..." |
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
locationBias |
类型:
LocationBias optional在搜索地点时使用的软边界或提示。 |
locationRestriction |
类型:
LocationRestriction optional用于限制搜索结果的边界。 |
maxlength
attr: maxlength |
类型:
number optional用户可以输入的最大字符数。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength。
HTML 属性: maxlength="number" |
name
attr: name |
类型:
string optional要用于输入元素的名称。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name。遵循与输入的 name 属性相同的行为。请注意,这是提交表单时将使用的名称。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form。
HTML 属性: name="string" |
noClearButton
attr: no-clear-button |
输入类型:
boolean optional输出类型: boolean是否隐藏清除按钮。
HTML 属性: no-clear-button |
noInputIcon
attr: no-input-icon |
输入类型:
boolean optional输出类型: boolean是否隐藏输入图标。
HTML 属性: no-input-icon |
origin
attr: origin |
输入类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional输出类型: LatLngAltitude optional计算距离的起点。如果未指定,则不计算距离。如果提供了海拔高度,则不会在计算中使用。
HTML 属性:
|
placeholder
attr: placeholder |
类型:
string optional要用于输入元素的占位文本。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder。
HTML 属性: placeholder="string" |
pureServiceAreaBusinessesIncluded
attr: pure-service-area-businesses-included |
类型:
boolean optional是否包含纯上门服务商家。
HTML 属性: pure-service-area-businesses-included |
readonly
attr: readonly |
输入类型:
boolean optional输出类型: boolean输入元素是否为只读。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly。
HTML 属性: readonly |
requestedLanguage
attr: requested-language |
类型:
string optional语言标识符,用于指定返回结果时应使用的语言(如果可能)。所选语言的结果可能会获得更高的排名,但建议并不局限于此语言。请参阅支持的语言列表。
HTML 属性: requested-language="string" |
requestedRegion
attr: requested-region |
类型:
string optional用于结果格式设置和结果过滤的地区代码。它不会将建议限制为此国家/地区。地区代码接受 ccTLD(“顶级域名”)双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同,但也有一些需要注意的例外情况。例如,英国的 ccTLD 为“uk”(
.co.uk),而其 ISO 3166-1 代码为“gb”(代表“大不列颠及北爱尔兰联合王国”)。HTML 属性: requested-region="string" |
unitSystem
attr: unit-system |
用于显示距离的单位制。如果未指定,则单位制由 requestedRegion 决定。
HTML 属性: unit-system="value-name" |
value |
输入类型:
string optional输出类型: string输入元素的值。 |
槽数 | |
|---|---|
clear-icon |
将插槽元素放置在清除图标位置。当输入框中有文本时,清除按钮会显示在输入框末尾。 |
input-icon |
将槽位元素放置在输入图标位置。在内嵌模式下,输入图标会显示在输入框的开头。 |
prediction-item-icon |
此槽仅接受一个 <template> 元素,该元素会呈现为联想查询项旁边显示的图标。 |
零件 | |
|---|---|
focus-ring |
用于在获得焦点的元素(输入或联想查询项)周围显示焦点环的元素 |
input |
自动补全元素的输入元素。 |
prediction-item |
预测结果下拉列表中的一个条目,代表一个预测结果。 |
prediction-item-icon |
预测项列表中显示在每个项目左侧的图标。 |
prediction-item-main-text |
prediction-item 的一部分,它是预测结果的主要文本。对地理位置而言,它会包含地点名称(如“上海”)或街道名称和编号(如“长安大街3号”)。默认情况下,prediction-item-main-text 显示为黑色。如果 prediction-item 中有任何附加文本,该文本将位于 prediction-item-main-text 之外,并且继承 prediction-item 的样式。默认情况下,此类文本会显示为灰色。附加文本通常是地址。 |
prediction-item-match |
返回的联想查询的一部分,其于用户输入相匹配。默认情况下,该匹配文本以粗体突出显示。请注意,匹配的文本仅在 prediction-item-main-text 中突出显示。 |
prediction-item-nonmatch |
预测结果主要文本中与用户输入的内容不匹配的部分。 |
prediction-item-secondary-text |
prediction-item 的一部分,是预测结果的次要文本。附加文本通常为地址。 |
prediction-item-selected |
用户通过键盘导航到的条目。注意:所选内容会同时受此部分样式和 prediction-item 部分样式的影响。 |
prediction-list |
视觉元素,其包含由商家信息自动填充服务所返回的联想查询列表。此列表通过下拉列表的形式显示在 PlaceAutocompleteElement 下方。 |
CSS 属性 | |
|---|---|
background-color |
替换元素的背景颜色。 |
border |
替换元素的边框。 |
border-radius |
替换元素的边框半径。 |
color |
替换元素的字体。 |
color-scheme |
|
font |
替换元素的字体。 |
font-family |
替换元素的字体。 |
font-size |
替换元素的字体。 |
font-style |
替换元素的字体。 |
font-weight |
替换元素的字体。 |
line-height |
替换元素的字体。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(errorEvent)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-select |
function(placePredictionSelectEvent)参数:
当用户选择地点联想查询时,系统会触发此事件。包含可转换为 Place 对象的 PlacePrediction 对象。 |
PlaceAutocompleteElementOptions 接口
接口
google.maps.places.PlaceAutocompleteElementOptions
由 PlaceAutocompleteElement 实现
用于构建 PlaceAutocompleteElement 的选项。如需了解每个属性的说明,请参阅 PlaceAutocompleteElement 类中的同名属性。
属性 | |
|---|---|
description
可选 |
类型:
string optional要用于输入元素的说明。当输入元素获得焦点时,屏幕阅读器会检测到此属性。 |
disabled
可选 |
类型:
boolean optional |
futureOpeningBusinessesIncluded
可选 |
类型:
boolean optional |
includedPrimaryTypes
可选 |
类型:
Array<string> optional |
includedRegionCodes
可选 |
类型:
Array<string> optional |
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional |
locationBias
可选 |
类型:
LocationBias optional |
locationRestriction
可选 |
类型:
LocationRestriction optional |
maxlength
可选 |
类型:
number optional |
name
可选 |
类型:
string optional |
noClearButton
可选 |
类型:
boolean optional |
noInputIcon
可选 |
类型:
boolean optional |
origin
可选 |
类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional |
placeholder
可选 |
类型:
string optional |
pureServiceAreaBusinessesIncluded
可选 |
类型:
boolean optional |
readonly
可选 |
类型:
boolean optional |
requestedLanguage
可选 |
类型:
string optional |
requestedRegion
可选 |
类型:
string optional |
unitSystem
可选 |
类型:
UnitSystem optional |
value
可选 |
类型:
string optional输入元素的值。 |
PlacePredictionSelectEvent 类
class
google.maps.places.PlacePredictionSelectEvent
extends Event
library "places"
此事件会在用户使用 PlaceAutocompleteElement 选择预测结果项后创建。使用 event.placePrediction 访问所选内容。
通过调用 PlacePrediction.toPlace 将 placePrediction 转换为 Place。
const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places");
属性 | |
|---|---|
placePrediction
readonly |
通过调用 PlacePrediction.toPlace 将其转换为 Place。 |
BasicPlaceAutocompleteElement 类
class
google.maps.places.BasicPlaceAutocompleteElement
extends HTMLElement
implements BasicPlaceAutocompleteElementOptions
library "places"
BasicPlaceAutocompleteElement 是 HTMLElement 子类,可为 Places Autocomplete API 提供界面组件。
<gmp-basic-place-autocomplete description="string" disabled future-opening-businesses-included included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." internal-usage-attribution-ids="space separated strings" maxlength="number" name="string" no-clear-button no-input-icon origin="lat,lng" placeholder="string" pure-service-area-businesses-included readonly requested-language="string" requested-region="string" unit-system="value-name"> </gmp-basic-place-autocomplete>
const {BasicPlaceAutocompleteElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
BasicPlaceAutocompleteElement |
BasicPlaceAutocompleteElement([options])参数:
|
属性 | |
|---|---|
description
attr: description |
类型:
string optional要用于输入元素的说明。当输入元素获得焦点时,屏幕阅读器会检测到此属性。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby。
HTML 属性: description="string" |
disabled
attr: disabled |
输入类型:
boolean optional输出类型: boolean输入元素是否已停用。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#disabled。
HTML 属性: disabled |
futureOpeningBusinessesIncluded
attr: future-opening-businesses-included |
类型:
boolean optional是否包含尚未开业但预计未来会开业的地点。
HTML 属性: future-opening-businesses-included |
includedPrimaryTypes
attr: included-primary-types |
类型:
Array<string> optional包含的主要地点类型(例如“restaurant”或“gas_station”)。
只有在地点的主要类型包含在此列表中时,系统才会返回该地点。最多可以指定 5 个值。如果未指定任何类型,系统将返回所有地点类型。 HTML 属性: included-primary-types="type1 type2 type3..." |
includedRegionCodes
attr: included-region-codes |
类型:
Array<string> optional仅包含指定区域的结果,最多可指定 15 个 CLDR 双字符区域代码。空集不会限制结果。如果同时设置了
locationRestriction 和 includedRegionCodes,则结果将位于交集区域。HTML 属性: included-region-codes="c1 c2 c3..." |
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
locationBias |
类型:
LocationBias optional在搜索地点时使用的软边界或提示。 |
locationRestriction |
类型:
LocationRestriction optional用于限制搜索结果的边界。 |
maxlength
attr: maxlength |
类型:
number optional用户可以输入的最大字符数。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength。
HTML 属性: maxlength="number" |
name
attr: name |
类型:
string optional要用于输入元素的名称。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name。遵循与输入的 name 属性相同的行为。请注意,这是提交表单时将使用的名称。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form。
HTML 属性: name="string" |
noClearButton
attr: no-clear-button |
输入类型:
boolean optional输出类型: boolean是否隐藏清除按钮。
HTML 属性: no-clear-button |
noInputIcon
attr: no-input-icon |
输入类型:
boolean optional输出类型: boolean是否隐藏输入图标。
HTML 属性: no-input-icon |
origin
attr: origin |
输入类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional输出类型: LatLngAltitude optional计算距离的起点。如果未指定,则不计算距离。如果提供了海拔高度,则不会在计算中使用。
HTML 属性:
|
placeholder
attr: placeholder |
类型:
string optional要用于输入元素的占位文本。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder。
HTML 属性: placeholder="string" |
pureServiceAreaBusinessesIncluded
attr: pure-service-area-businesses-included |
类型:
boolean optional是否包含纯上门服务商家。
HTML 属性: pure-service-area-businesses-included |
readonly
attr: readonly |
输入类型:
boolean optional输出类型: boolean输入元素是否为只读。如需了解详情,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly。
HTML 属性: readonly |
requestedLanguage
attr: requested-language |
类型:
string optional语言标识符,用于指定返回结果时应使用的语言(如果可能)。所选语言的结果可能会获得更高的排名,但建议并不局限于此语言。请参阅支持的语言列表。
HTML 属性: requested-language="string" |
requestedRegion
attr: requested-region |
类型:
string optional用于结果格式设置和结果过滤的地区代码。它不会将建议限制为此国家/地区。地区代码接受 ccTLD(“顶级域名”)双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同,但也有一些需要注意的例外情况。例如,英国的 ccTLD 为“uk”(
.co.uk),而其 ISO 3166-1 代码为“gb”(代表“大不列颠及北爱尔兰联合王国”)。HTML 属性: requested-region="string" |
unitSystem
attr: unit-system |
用于显示距离的单位制。如果未指定,则单位制由 requestedRegion 决定。
HTML 属性: unit-system="value-name" |
槽数 | |
|---|---|
clear-icon |
将插槽元素放置在清除图标位置。当输入框中有文本时,清除按钮会显示在输入框末尾。 |
input-icon |
将槽位元素放置在输入图标位置。在内嵌模式下,输入图标会显示在输入框的开头。 |
prediction-item-icon |
此槽仅接受一个 <template> 元素,该元素会呈现为联想查询项旁边显示的图标。 |
零件 | |
|---|---|
focus-ring |
用于在获得焦点的元素(输入或联想查询项)周围显示焦点环的元素 |
input |
自动补全元素的输入元素。 |
prediction-item |
预测结果下拉列表中的一个条目,代表一个预测结果。 |
prediction-item-icon |
预测项列表中显示在每个项目左侧的图标。 |
prediction-item-main-text |
prediction-item 的一部分,它是预测结果的主要文本。对地理位置而言,它会包含地点名称(如“上海”)或街道名称和编号(如“长安大街3号”)。默认情况下,prediction-item-main-text 显示为黑色。如果 prediction-item 中有任何附加文本,该文本将位于 prediction-item-main-text 之外,并且继承 prediction-item 的样式。默认情况下,此类文本会显示为灰色。附加文本通常是地址。 |
prediction-item-match |
返回的联想查询的一部分,其于用户输入相匹配。默认情况下,该匹配文本以粗体突出显示。请注意,匹配的文本仅在 prediction-item-main-text 中突出显示。 |
prediction-item-nonmatch |
预测结果主要文本中与用户输入的内容不匹配的部分。 |
prediction-item-secondary-text |
prediction-item 的一部分,是预测结果的次要文本。附加文本通常为地址。 |
prediction-item-selected |
用户通过键盘导航到的条目。注意:所选内容会同时受此部分样式和 prediction-item 部分样式的影响。 |
prediction-list |
视觉元素,其包含由商家信息自动填充服务所返回的联想查询列表。此列表通过下拉列表的形式显示在 PlaceAutocompleteElement 下方。 |
CSS 属性 | |
|---|---|
background-color |
替换元素的背景颜色。 |
border |
替换元素的边框。 |
border-radius |
替换元素的边框半径。 |
color |
替换元素的字体。 |
color-scheme |
|
font |
替换元素的字体。 |
font-family |
替换元素的字体。 |
font-size |
替换元素的字体。 |
font-style |
替换元素的字体。 |
font-weight |
替换元素的字体。 |
line-height |
替换元素的字体。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(errorEvent)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-select |
function(placeSelectEvent)参数:
当用户选择地点联想查询时,系统会触发此事件。包含 Place 对象。 |
BasicPlaceAutocompleteElementOptions 接口
接口
google.maps.places.BasicPlaceAutocompleteElementOptions
由 BasicPlaceAutocompleteElement 实现
用于构建 BasicPlaceAutocompleteElement 的选项。
属性 | |
|---|---|
description
可选 |
类型:
string optional要用于输入元素的说明。当输入元素获得焦点时,屏幕阅读器会检测到此属性。 |
disabled
可选 |
类型:
boolean optional |
futureOpeningBusinessesIncluded
可选 |
类型:
boolean optional |
includedPrimaryTypes
可选 |
类型:
Array<string> optional |
includedRegionCodes
可选 |
类型:
Array<string> optional |
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional |
locationBias
可选 |
类型:
LocationBias optional |
locationRestriction
可选 |
类型:
LocationRestriction optional |
maxlength
可选 |
类型:
number optional |
name
可选 |
类型:
string optional |
noClearButton
可选 |
类型:
boolean optional |
noInputIcon
可选 |
类型:
boolean optional |
origin
可选 |
类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional |
placeholder
可选 |
类型:
string optional |
pureServiceAreaBusinessesIncluded
可选 |
类型:
boolean optional |
readonly
可选 |
类型:
boolean optional |
requestedLanguage
可选 |
类型:
string optional |
requestedRegion
可选 |
类型:
string optional |
unitSystem
可选 |
类型:
UnitSystem optional |
PlaceDetailsElement 类
class
google.maps.places.PlaceDetailsElement
extends HTMLElement
implements PlaceDetailsElementOptions
extended by AdvancedPlaceDetailsElement
library "places"
以完整布局显示地点的详细信息。附加 PlaceDetailsPlaceRequestElement 或 PlaceDetailsLocationRequestElement 以指定要呈现的地点。附加 、PlaceContentConfigElementPlaceStandardContentElement 或 PlaceAllContentElement,以指定要呈现的内容。
示例:
<gmp-place-details>
<gmp-place-details-place-request
place="PLACE_ID"
></gmp-place-details-place-request>
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
</gmp-place-details> 如需使用此元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-place-details internal-usage-attribution-ids="space separated strings"> </gmp-place-details>
const {PlaceDetailsElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceDetailsElement |
PlaceDetailsElement([options])参数:
|
属性 | |
|---|---|
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
place
readonly |
类型:
Place optional只读。Place 对象,其中包含当前呈现的地点的 ID、位置和视口。 |
CSS 属性 | |
|---|---|
--gmp-button-border-color |
“在地图中打开”按钮的边框颜色。 |
--gmp-button-border-radius |
“在地图中打开”按钮的边框半径。 |
--gmp-button-border-width |
“在地图中打开”按钮的边框宽度。 |
--gmp-collage-border-radius-outer |
媒体拼贴外角的边框半径。 |
--gmp-dialog-border-radius |
Google 地图披露对话框的边框半径。 |
--gmp-mat-color-disabled-surface |
用于传达停用状态或不存在状态的表面色。用于表示空评价星级。 |
--gmp-mat-color-info |
具有信息性情感的界面元素的颜色。用于轮椅图标。 |
--gmp-mat-color-negative |
带有负面情绪的界面元素的颜色。用于“正在营业”状态中的“已打烊”文本。 |
--gmp-mat-color-neutral-container |
中性填充界面元素的容器颜色。用于图片占位符和评价发布日期标记。 |
--gmp-mat-color-on-neutral-container |
与中性容器颜色形成对比的文字和图标颜色。用于评价发布日期标志和电动汽车充电桩可用性标志(不可用时)。 |
--gmp-mat-color-on-positive-container |
与正面容器颜色形成对比的文本和图标颜色。用于电动汽车充电桩可用性标志(如有)。 |
--gmp-mat-color-on-secondary-container |
与次要容器颜色形成对比的文字和图标颜色。用于“在 Google 地图中打开”按钮上的文字和图标。 |
--gmp-mat-color-on-surface |
与任何 surface 颜色搭配使用的文字和图标颜色。用于常规文本。 |
--gmp-mat-color-on-surface-variant |
在任何 Surface 颜色上,文本和图标的强调色都较低。用于不太强调的文本。 |
--gmp-mat-color-outline-decorative |
非互动元素的轮廓颜色。用于元素的边框。 |
--gmp-mat-color-positive |
具有积极情绪的界面元素的颜色。用于“正在营业”状态中的“营业中”文本。 |
--gmp-mat-color-positive-container |
用于传达积极情绪的界面元素的容器颜色。用于电动汽车充电桩可用性标志(如有)。 |
--gmp-mat-color-primary |
互动文本和图标与表面颜色的对比色。用于评价数量、Google 地图披露信息对话框中的链接、网站链接、“概览”标签页中的图标,以及标签页栏标题(悬停/焦点/文字颜色)。 |
--gmp-mat-color-secondary-container |
与表面色相比,填充颜色不太显眼,适用于色调按钮等隐性组件。用于“在地图中打开”按钮的背景。 |
--gmp-mat-color-surface |
背景颜色。用于元素和 Google 地图披露信息对话框的背景。 |
--gmp-mat-font-body-medium |
用于 Google 地图披露信息对话框中的地点地址、评分、类型、价格、当前营业状态、营业时间、评价、电话号码、网站、Plus Code、主要功能和正文。 |
--gmp-mat-font-body-small |
用于“关于”标签页中功能列表的正文。 |
--gmp-mat-font-display-small |
用于“关于”标签页中的地点名称和每个功能标题的文本。 |
--gmp-mat-font-family |
用于所有文本的基本字体系列。 |
--gmp-mat-font-headline-medium |
用于 Google 地图披露信息对话框中的标题文本。 |
--gmp-mat-font-label-large |
用于标签页标题、“在 Google 地图中打开”按钮、照片库中的评价者提供方文字、评价部分中的评价者提供方文字,以及 Google 地图披露信息对话框中的链接。 |
--gmp-mat-font-label-medium |
用于照片数量标记和评价发布日期标记。 |
--gmp-mat-font-title-small |
用于“关于”标签页中每个部分的标题。 |
--gmp-mat-spacing-extra-large |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-extra-small |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-large |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-medium |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-small |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-two-extra-large |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-star-rating-color |
评分中已填充星星的颜色。 |
background-color |
替换元素的背景颜色。 |
border |
替换元素的边框。 |
border-radius |
替换元素的边框半径。 |
color-scheme |
|
font-size |
缩放元素中的所有文本和图标,这些文本和图标在内部以 em 为单位进行定义。默认为 16px。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-load |
function(event)参数:
当元素加载并呈现其内容时,会触发此事件。此事件不会冒泡。 |
PlaceDetailsElementOptions 接口
接口
google.maps.places.PlaceDetailsElementOptions
由 AdvancedPlaceDetailsElementOptions 扩展
由 AdvancedPlaceDetailsElement, PlaceDetailsElement 实现
“PlaceDetailsElement”的选项。
属性 | |
|---|---|
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
PlaceDetailsCompactElement 类
class
google.maps.places.PlaceDetailsCompactElement
extends HTMLElement
implements PlaceDetailsCompactElementOptions
extended by AdvancedPlaceDetailsCompactElement
library "places"
以紧凑布局显示地点的详细信息。附加 PlaceDetailsPlaceRequestElement 或 PlaceDetailsLocationRequestElement 以指定要呈现的地点。附加 、PlaceContentConfigElementPlaceStandardContentElement 或 PlaceAllContentElement,以指定要呈现的内容。
示例:
<gmp-place-details-compact>
<gmp-place-details-place-request
place="PLACE_ID"
></gmp-place-details-place-request>
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
</gmp-place-details-compact> 如需使用此元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-place-details-compact internal-usage-attribution-ids="space separated strings" orientation="value-name" truncation-preferred> </gmp-place-details-compact>
const {PlaceDetailsCompactElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceDetailsCompactElement |
PlaceDetailsCompactElement([options])参数:
|
属性 | |
|---|---|
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
orientation
attr: orientation |
类型:
PlaceDetailsOrientation optional默认值:
PlaceDetailsOrientation.VERTICAL元素的方向变体(垂直或水平)。
HTML 属性: orientation="value-name" |
place
readonly |
类型:
Place optional只读。Place 对象,其中包含当前呈现的地点的 ID、位置和视口。 |
truncationPreferred
attr: truncation-preferred |
输入类型:
boolean optional输出类型: boolean默认值:
false如果为 true,则会截断地点名称和地址,使其显示在一行中,而不是换行。
HTML 属性: truncation-preferred |
CSS 属性 | |
|---|---|
--gmp-button-border-color |
“在地图中打开”按钮的边框颜色。 |
--gmp-button-border-radius |
“在地图中打开”按钮的边框半径。 |
--gmp-button-border-width |
“在地图中打开”按钮的边框宽度。 |
--gmp-dialog-border-radius |
Google 地图披露对话框的边框半径。 |
--gmp-mat-color-info |
具有信息性情感的界面元素的颜色。用于轮椅图标。 |
--gmp-mat-color-negative |
带有负面情绪的界面元素的颜色。用于“正在营业”状态中的“已打烊”文本。 |
--gmp-mat-color-neutral-container |
中性填充界面元素的容器颜色。用于图片占位符。 |
--gmp-mat-color-on-secondary-container |
与次要容器颜色形成对比的文字和图标颜色。用于“在 Google 地图中打开”按钮上的文字和图标。 |
--gmp-mat-color-on-surface |
与任何 surface 颜色搭配使用的文字和图标颜色。用于常规文本。 |
--gmp-mat-color-on-surface-variant |
在任何 Surface 颜色上,文本和图标的强调色都较低。用于不太强调的文本。 |
--gmp-mat-color-outline-decorative |
非互动元素的轮廓颜色。用于元素的边框。 |
--gmp-mat-color-positive |
具有积极情绪的界面元素的颜色。用于“正在营业”状态中的“营业中”文本。 |
--gmp-mat-color-primary |
互动文本和图标与表面颜色的对比色。用于评价数量,以及 Google 地图披露信息对话框中的链接。 |
--gmp-mat-color-secondary-container |
与表面色相比,填充颜色不太显眼,适用于色调按钮等隐性组件。用于“在地图中打开”按钮的背景。 |
--gmp-mat-color-surface |
背景颜色。用于元素和 Google 地图披露信息对话框的背景。 |
--gmp-mat-font-body-medium |
用于 Google 地图披露信息对话框中的正文。 |
--gmp-mat-font-body-small |
用于显示地点地址、评分、类型、价格和当前营业状态。 |
--gmp-mat-font-family |
用于所有文本的基本字体系列。 |
--gmp-mat-font-headline-medium |
用于 Google 地图披露信息对话框中的标题文本。 |
--gmp-mat-font-label-large |
用于“在 Google 地图中打开”按钮、Google 地图披露信息对话框中的链接,以及照片库中的评价者提供方文字。 |
--gmp-mat-font-label-medium |
用于照片数量标记。 |
--gmp-mat-font-title-small |
用于地点名称。 |
--gmp-mat-spacing-extra-small |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-large |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-medium |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-mat-spacing-small |
用于元素内的间距,例如文本周围的外边距和内边距。 |
--gmp-star-rating-color |
评分中已填充星星的颜色。 |
--gmp-thumbnail-border-radius |
地点缩略图的边框半径。 |
background-color |
替换元素的背景颜色。 |
border |
替换元素的边框。 |
border-radius |
替换元素的边框半径。 |
color-scheme |
|
font-size |
缩放元素中的所有文本和图标,这些文本和图标在内部以 em 为单位进行定义。默认为 16px。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-load |
function(event)参数:
当元素加载并呈现其内容时,会触发此事件。此事件不会冒泡。 |
PlaceDetailsCompactElementOptions 接口
接口
google.maps.places.PlaceDetailsCompactElementOptions
由 AdvancedPlaceDetailsCompactElementOptions 扩展
由 AdvancedPlaceDetailsCompactElement, PlaceDetailsCompactElement 实现
“PlaceDetailsCompactElement”的选项。
属性 | |
|---|---|
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
orientation
可选 |
类型:
PlaceDetailsOrientation optional |
truncationPreferred
可选 |
类型:
boolean optional |
AdvancedPlaceDetailsElement 类
class
google.maps.places.AdvancedPlaceDetailsElement
extends PlaceDetailsElement, HTMLElement
implements AdvancedPlaceDetailsElementOptions, PlaceDetailsElementOptions
library "places"
以完整布局显示地点的详细信息。附加 PlaceDetailsPlaceRequestElement 或 PlaceDetailsLocationRequestElement 以指定要呈现的地点。直接附加 PlaceStandardContentElement、PlaceAllContentElement 或地点详情元素,以配置要呈现的内容。
示例:
<gmp-advanced-place-details>
<gmp-place-details-place-request
place="PLACE_ID"
></gmp-place-details-place-request>
<gmp-place-standard-content>
</gmp-place-standard-content>
</gmp-advanced-place-details> 如需使用此元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-advanced-place-details internal-usage-attribution-ids="space separated strings"> </gmp-advanced-place-details>
const {AdvancedPlaceDetailsElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
AdvancedPlaceDetailsElement |
AdvancedPlaceDetailsElement([options])参数:
|
属性 | |
|---|---|
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
place
readonly |
类型:
Place optional只读。Place 对象,其中包含当前呈现的地点的 ID、位置和视口。 |
槽数 | |
|---|---|
action-corner |
|
action-main |
|
|
一个用于自定义 HTML 内容的槽,在基本信息部分的底部(主操作按钮的正下方)呈现。 |
|
一个槽,用于在基本信息部分(地点名称正上方)呈现自定义 HTML 内容。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
继承的方法:
gmp-error、gmp-load
|
AdvancedPlaceDetailsElementOptions 接口
interface
google.maps.places.AdvancedPlaceDetailsElementOptions
extends PlaceDetailsElementOptions
implemented by AdvancedPlaceDetailsElement
“AdvancedPlaceDetailsElement”的选项。
属性 | |
|---|---|
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
AdvancedPlaceDetailsCompactElement 类
class
google.maps.places.AdvancedPlaceDetailsCompactElement
extends PlaceDetailsCompactElement, HTMLElement
implements AdvancedPlaceDetailsCompactElementOptions, PlaceDetailsCompactElementOptions
library "places"
以紧凑布局显示地点的详细信息。附加 PlaceDetailsPlaceRequestElement 或 PlaceDetailsLocationRequestElement 以指定要呈现的地点。附加 PlaceStandardContentElement、PlaceAllContentElement 或指定特定的内容子项,以配置要呈现的内容。
如需使用此元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-advanced-place-details-compact internal-usage-attribution-ids="space separated strings"> </gmp-advanced-place-details-compact>
const {AdvancedPlaceDetailsCompactElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
AdvancedPlaceDetailsCompactElement |
AdvancedPlaceDetailsCompactElement([options])参数:
|
属性 | |
|---|---|
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
place
readonly |
类型:
Place optional只读。Place 对象,其中包含当前呈现的地点的 ID、位置和视口。 |
继承的方法:
orientation(属性:orientation)、truncationPreferred(属性:truncation-preferred)
| |
槽数 | |
|---|---|
action-corner |
|
action-main |
|
|
一个用于自定义 HTML 内容的槽,在基本信息部分的底部(主操作按钮的正下方)呈现。 |
|
一个槽,用于在基本信息部分(地点名称正上方)呈现自定义 HTML 内容。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
继承的方法:
gmp-error、gmp-load
|
AdvancedPlaceDetailsCompactElementOptions 接口
interface
google.maps.places.AdvancedPlaceDetailsCompactElementOptions
extends PlaceDetailsCompactElementOptions
implemented by AdvancedPlaceDetailsCompactElement
“AdvancedPlaceDetailsCompactElement”的选项。
属性 | |
|---|---|
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
继承的方法:
orientation、truncationPreferred
| |
PlaceDetailsOrientation 常量
常量
google.maps.places.PlaceDetailsOrientation
库 "places"
PlaceDetailsCompactElement 的方向变体。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 PlaceDetailsOrientationString 类型定义。
const {PlaceDetailsOrientation} = await google.maps.importLibrary("places");
常量 | |
|---|---|
HORIZONTAL |
横向。 |
VERTICAL |
垂直方向。 |
PlaceDetailsPlaceRequestElement 类
class
google.maps.places.PlaceDetailsPlaceRequestElement
extends HTMLElement
implements PlaceDetailsPlaceRequestElementOptions
library "places"
配置 PlaceDetailsCompactElement 或 PlaceDetailsElement,以根据地点对象、ID 或资源名称加载数据。将此元素附加为 PlaceDetailsCompactElement 或 PlaceDetailsElement 的子元素,以加载指定地点的数据。例如:
<gmp-place-details>
<gmp-place-details-place-request
place="PLACE_ID"
></gmp-place-details-place-request>
</gmp-place-details> <gmp-place-details-place-request place="places/###"> </gmp-place-details-place-request>
const {PlaceDetailsPlaceRequestElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceDetailsPlaceRequestElement |
PlaceDetailsPlaceRequestElement([options])参数:
|
属性 | |
|---|---|
place
attr: place |
默认值:
null要在“地点详情(精简版)”元素中呈现其详情的地点对象、ID 或资源名称。此属性会作为资源名称反映到该属性。
HTML 属性: place="places/###" |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceDetailsPlaceRequestElementOptions 接口
接口
google.maps.places.PlaceDetailsPlaceRequestElementOptions
由 PlaceDetailsPlaceRequestElement 实现
“PlaceDetailsPlaceRequestElement”的选项。
属性 | |
|---|---|
place
可选 |
类型:
Place|string optional |
PlaceDetailsLocationRequestElement 类
class
google.maps.places.PlaceDetailsLocationRequestElement
extends HTMLElement
implements PlaceDetailsLocationRequestElementOptions
library "places"
配置 PlaceDetailsCompactElement 或 PlaceDetailsElement,以根据位置加载数据。将此元素附加为 PlaceDetailsCompactElement 或 PlaceDetailsElement 的子元素,以加载指定位置的数据。例如:
<gmp-place-details>
<gmp-place-details-location-request
location="37.6207665,-122.4284806"
></gmp-place-details-location-request>
</gmp-place-details> <gmp-place-details-location-request location="lat,lng"> </gmp-place-details-location-request>
const {PlaceDetailsLocationRequestElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceDetailsLocationRequestElement |
PlaceDetailsLocationRequestElement([options])参数:
|
属性 | |
|---|---|
location
attr: location |
输入类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional输出类型: LatLngAltitude optional默认值:
null要在“地点详情”元素中呈现其详细信息的地点。归一化为
LatLngAltitude。HTML 属性: location="lat,lng" |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceDetailsLocationRequestElementOptions 接口
接口
google.maps.places.PlaceDetailsLocationRequestElementOptions
由 PlaceDetailsLocationRequestElement 实现
“PlaceDetailsLocationRequestElement”的选项。
属性 | |
|---|---|
location
可选 |
类型:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optional要呈现地点的地理位置。 |
PlaceSearchElement 类
class
google.maps.places.PlaceSearchElement
extends HTMLElement
implements PlaceSearchElementOptions
extended by AdvancedPlaceSearchElement
library "places"
以列表形式显示地点搜索结果。附加 PlaceTextSearchRequestElement 或 PlaceNearbySearchRequestElement,以指定要呈现其结果的请求。附加 、PlaceContentConfigElementPlaceStandardContentElement 或 PlaceAllContentElement,以指定要呈现的内容。
示例:
<gmp-place-search>
<gmp-place-text-search-request
text-query="QUERY"
></gmp-place-text-search-request>
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
</gmp-place-search> 如需使用地点搜索元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-place-search attribution-position="value-name" internal-usage-attribution-ids="space separated strings" orientation="value-name" selectable truncation-preferred> </gmp-place-search>
const {PlaceSearchElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceSearchElement |
PlaceSearchElement([options])参数:
|
属性 | |
|---|---|
attributionPosition
attr: attribution-position |
默认值:
PlaceSearchAttributionPosition.TOP提供方徽标和依法披露按钮的位置。
HTML 属性: attribution-position="value-name" |
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
orientation
attr: orientation |
默认值:
PlaceSearchOrientation.VERTICAL元素的方向变体(垂直或水平)。
HTML 属性: orientation="value-name" |
places
readonly |
只读。 Place 对象数组,其中包含当前呈现的地点的 ID、位置和视口。 |
selectable
attr: selectable |
输入类型:
boolean optional输出类型: boolean默认值:
false列表项是否可供选择。如果为 true,列表项将是按钮,点击时会分派
gmp-select 事件。此外,还支持无障碍键盘导航和选择。HTML 属性: selectable |
truncationPreferred
attr: truncation-preferred |
输入类型:
boolean optional输出类型: boolean默认值:
false如果为 true,则会截断某些内容行,使其在一行中显示,而不是换行。
HTML 属性: truncation-preferred |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-load |
function(event)参数:
当元素加载并呈现其内容时,会触发此事件。此事件不会冒泡。 |
gmp-select |
function(event)参数:
当用户从列表中选择地点时,系统会触发此事件。包含一个 Place 对象,其中包含所选地点的 ID、位置和视口。 |
PlaceSearchElementOptions 接口
接口
google.maps.places.PlaceSearchElementOptions
由 AdvancedPlaceSearchElementOptions 扩展
由 AdvancedPlaceSearchElement, PlaceSearchElement 实现
“PlaceSearchElement”的选项。
属性 | |
|---|---|
attributionPosition
可选 |
类型:
PlaceSearchAttributionPosition optional |
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
orientation
可选 |
类型:
PlaceSearchOrientation optional |
selectable
可选 |
类型:
boolean optional |
truncationPreferred
可选 |
类型:
boolean optional |
PlaceItemElement 类
class
google.maps.places.PlaceItemElement
extends HTMLElement
implements PlaceItemElementOptions
extended by AdvancedPlaceItemElement
library "places"
地点列表项的公共 Web 组件封装容器 (<gmp-place-item>)。<gmp-place-item> 自定义元素会在 <gmp-place-search> 内呈现单个地点结果卡片。每个 <gmp-place-item> 都会显示由 Places UI Kit 中的子级视觉组件组成的地点信息。
<gmp-place-item></gmp-place-item>
const {PlaceItemElement} = await google.maps.importLibrary("places");
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceItemElementOptions 接口
接口
google.maps.places.PlaceItemElementOptions
由 AdvancedPlaceItemElementOptions 扩展
由 AdvancedPlaceItemElement, PlaceItemElement 实现
“PlaceItemElement”的选项。
AdvancedPlaceSearchElement 类
class
google.maps.places.AdvancedPlaceSearchElement
extends PlaceSearchElement, HTMLElement
implements AdvancedPlaceSearchElementOptions, PlaceSearchElementOptions
library "places"
以列表形式显示高级地点搜索的结果。附加 PlaceTextSearchRequestElement 或 PlaceNearbySearchRequestElement,以指定要呈现其结果的请求。附加 PlaceStandardContentElement、PlaceAllContentElement 或 <template slot="details-item">,以指定要呈现的内容。
示例:
<gmp-advanced-place-search>
<gmp-place-text-search-request
text-query="QUERY"
></gmp-place-text-search-request>
<template slot="details-item">
<gmp-place-media lightbox-preferred></gmp-place-media>
</template>
</gmp-advanced-place-search> 如需使用高级地点搜索元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-advanced-place-search attribution-position="value-name" internal-usage-attribution-ids="space separated strings" orientation="value-name" selectable truncation-preferred> </gmp-advanced-place-search>
const {AdvancedPlaceSearchElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
AdvancedPlaceSearchElement |
AdvancedPlaceSearchElement([options])参数:
|
属性 | |
|---|---|
attributionPosition
attr: attribution-position |
默认值:
PlaceSearchAttributionPosition.TOP提供方徽标和依法披露按钮的位置。
HTML 属性: attribution-position="value-name" |
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
orientation
attr: orientation |
默认值:
PlaceSearchOrientation.VERTICAL元素的方向变体(垂直或水平)。
HTML 属性: orientation="value-name" |
selectable
attr: selectable |
输入类型:
boolean optional输出类型: boolean默认值:
false列表项是否可供选择。如果为 true,列表项将是按钮,点击时会分派
gmp-select 事件。此外,还支持无障碍键盘导航和选择。HTML 属性: selectable |
truncationPreferred
attr: truncation-preferred |
输入类型:
boolean optional输出类型: boolean默认值:
false如果为 true,则会截断某些内容行,使其在一行中显示,而不是换行。
HTML 属性: truncation-preferred |
继承:
places
| |
槽数 | |
|---|---|
details-item |
HTML 模板,其中包含要为搜索结果中的每个地点呈现的 gmp-place 地点微件。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-load |
function(event)参数:
当元素加载并呈现其内容时,会触发此事件。此事件不会冒泡。 |
gmp-select |
function(event)参数:
当用户从列表中选择地点时,系统会触发此事件。包含一个 Place 对象,其中包含所选地点的 ID、位置和视口。 |
AdvancedPlaceSearchElementOptions 接口
interface
google.maps.places.AdvancedPlaceSearchElementOptions
extends PlaceSearchElementOptions
implemented by AdvancedPlaceSearchElement
“AdvancedPlaceSearchElement”的选项。
属性 | |
|---|---|
attributionPosition
可选 |
类型:
PlaceSearchAttributionPosition optional |
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
orientation
可选 |
类型:
PlaceSearchOrientation optional |
selectable
可选 |
类型:
boolean optional |
truncationPreferred
可选 |
类型:
boolean optional |
AdvancedPlaceListElement 类
class
google.maps.places.AdvancedPlaceListElement
extends HTMLElement
implements AdvancedPlaceListElementOptions
library "places"
以列表形式显示地点搜索结果。附加一个或多个 PlaceDetailsPlaceRequestElement 或设置 places 属性,以指定要显示的地点。附加 PlaceStandardContentElement 或 PlaceAllContentElement 以指定要呈现的内容。
示例:
<gmp-advanced-place-list>
<gmp-place-details-place-request
place="PLACE_ID"
</gmp-place-details-place-request>
<template slot="details-item">
<gmp-place-media lightbox-preferred></gmp-place-media>
</template>
</gmp-advanced-place-list> 如需使用高级地点列表元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-advanced-place-list attribution-position="value-name" internal-usage-attribution-ids="space separated strings" orientation="value-name" places="space separated strings" selectable truncation-preferred> </gmp-advanced-place-list>
const {AdvancedPlaceListElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
AdvancedPlaceListElement |
AdvancedPlaceListElement([options])参数:
|
属性 | |
|---|---|
attributionPosition
attr: attribution-position |
默认值:
PlaceSearchAttributionPosition.TOP提供方徽标和依法披露按钮的位置。
HTML 属性: attribution-position="value-name" |
internalUsageAttributionIds
attr: internal-usage-attribution-ids |
用于将调用归因于特定软件包或 OSS 库的标识符。
HTML 属性: internal-usage-attribution-ids="space separated strings" |
orientation
attr: orientation |
默认值:
PlaceSearchOrientation.VERTICAL元素的方向变体(垂直或水平)。
HTML 属性: orientation="value-name" |
places
attr: places |
包含应在此元素中显示的 ID 的 Place 对象列表。请注意,如果无法呈现(例如,ID 无效、网络请求错误等),则可能不会显示在 places 属性中设置的所有地点。您可以读取 places 属性,以检索当前显示的地点。
HTML 属性: places="space separated strings" |
selectable
attr: selectable |
输入类型:
boolean optional输出类型: boolean默认值:
false列表项是否可供选择。如果为 true,列表项将是按钮,点击时会分派
gmp-select 事件。此外,还支持无障碍键盘导航和选择。HTML 属性: selectable |
truncationPreferred
attr: truncation-preferred |
输入类型:
boolean optional输出类型: boolean默认值:
false如果为 true,则会截断某些内容行,使其在一行中显示,而不是换行。
HTML 属性: truncation-preferred |
槽数 | |
|---|---|
details-item |
HTML 模板,其中包含要为列表中的每个地点呈现的 gmp-place 地点微件。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当对后端的请求被拒绝(例如 API 密钥不正确)时,会触发此事件。此事件不会冒泡。 |
gmp-load |
function(event)参数:
当元素加载并呈现其内容时,会触发此事件。此事件不会冒泡。 |
gmp-select |
function(event)参数:
当用户从列表中选择地点时,系统会触发此事件。包含一个 Place 对象,其中包含所选地点的 ID、位置和视口。 |
AdvancedPlaceListElementOptions 接口
接口
google.maps.places.AdvancedPlaceListElementOptions
由 AdvancedPlaceListElement 实现
“AdvancedPlaceListElement”的选项。
属性 | |
|---|---|
attributionPosition
可选 |
类型:
PlaceSearchAttributionPosition optional |
internalUsageAttributionIds
可选 |
类型:
Iterable<string> optional用于将调用归因于特定软件包或 OSS 库的标识符。 |
orientation
可选 |
类型:
PlaceSearchOrientation optional |
places
可选 |
|
selectable
可选 |
类型:
boolean optional |
truncationPreferred
可选 |
类型:
boolean optional |
AdvancedPlaceItemElement 类
class
google.maps.places.AdvancedPlaceItemElement
extends PlaceItemElement, HTMLElement
implements AdvancedPlaceItemElementOptions, PlaceItemElementOptions
library "places"
高级地点列表项的公共 Web 组件封装容器 (<gmp-advanced-place-item>)。<gmp-advanced-place-item> 自定义元素会在高级搜索或集合容器(例如 <gmp-advanced-place-search> 或 <gmp-advanced-place-list>)中呈现单个富媒体地点结果卡片。每个 <gmp-advanced-place-item> 都会呈现丰富的地点详情、媒体拼贴、编辑摘要和互动式操作按钮,这些内容由 Places UI Kit 中的子视觉组件组成。
<gmp-advanced-place-item></gmp-advanced-place-item>
const {AdvancedPlaceItemElement} = await google.maps.importLibrary("places");
槽数 | |
|---|---|
|
一个用于自定义 HTML 内容的槽,在基本信息部分的底部(主操作按钮的正下方)呈现。 |
|
一个槽,用于在基本信息部分(地点名称正上方)呈现自定义 HTML 内容。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
AdvancedPlaceItemElementOptions 接口
interface
google.maps.places.AdvancedPlaceItemElementOptions
extends PlaceItemElementOptions
implemented by AdvancedPlaceItemElement
“AdvancedPlaceItemElement”的选项。
PlaceSearchAttributionPosition 常量
常量
google.maps.places.PlaceSearchAttributionPosition
库 "places"
PlaceSearchElement 的归因位置。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 PlaceSearchAttributionPositionString 类型定义。
const {PlaceSearchAttributionPosition} = await google.maps.importLibrary("places");
常量 | |
|---|---|
BOTTOM |
PlaceSearchElement 底部的提供方信息 |
TOP |
PlaceSearchElement 顶部的提供方信息 |
PlaceSearchOrientation 常量
常量
google.maps.places.PlaceSearchOrientation
库 "places"
PlaceSearchElement 的方向变体。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 PlaceSearchOrientationString 类型定义。
const {PlaceSearchOrientation} = await google.maps.importLibrary("places");
常量 | |
|---|---|
HORIZONTAL |
横向。 |
VERTICAL |
垂直方向。 |
PlaceSelectEvent 类
class
google.maps.places.PlaceSelectEvent
extends Event
library "places"
此事件会在从地点列表中选择某个地点时触发。使用 event.place 访问所选内容。
const {PlaceSelectEvent} = await google.maps.importLibrary("places");
属性 | |
|---|---|
place
readonly |
类型:
Place所选地点。 |
PlaceNearbySearchRequestElement 类
class
google.maps.places.PlaceNearbySearchRequestElement
extends HTMLElement
implements PlaceNearbySearchRequestElementOptions
library "places"
配置 PlaceSearchElement,以根据附近搜索请求加载结果。locationRestriction 属性是加载搜索元素所必需的。如果未设置 locationRestriction,系统将忽略任何其他已配置的属性。将此元素附加为 PlaceSearchElement 的子元素,以加载结果。例如:
<gmp-place-search>
<gmp-place-nearby-search-request
location-restriction="RADIUS@LAT,LNG"
></gmp-place-nearby-search-request>
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
</gmp-place-search> <gmp-place-nearby-search-request excluded-primary-types="excluded-primary-type1 excluded-primary-type2..." excluded-types="excluded-type1 excluded-type2..." included-primary-types="included-primary-type1 included-primary-type2..." included-types="included-type1 included-type2..." location-restriction="radius@lat,lng" max-result-count="number" rank-preference="value-name"> </gmp-place-nearby-search-request>
const {PlaceNearbySearchRequestElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceNearbySearchRequestElement |
PlaceNearbySearchRequestElement([options])参数:
|
属性 | |
|---|---|
excludedPrimaryTypes
attr: excluded-primary-types |
默认值:
null已排除的主要地点类型。
HTML 属性: excluded-primary-types="excluded-primary-type1 excluded-primary-type2..." |
excludedTypes
attr: excluded-types |
默认值:
null排除的地点类型。
HTML 属性: excluded-types="excluded-type1 excluded-type2..." |
futureOpeningBusinessesIncluded |
输入类型:
boolean optional输出类型: boolean optional包含尚未开业但预计未来会开业的商家的地点联想查询。 |
includedPrimaryTypes
attr: included-primary-types |
默认值:
null包含的主要地点类型。
HTML 属性: included-primary-types="included-primary-type1 included-primary-type2..." |
includedTypes
attr: included-types |
默认值:
null包含的地点类型。
HTML 属性: included-types="included-type1 included-type2..." |
locationRestriction
attr: location-restriction |
默认值:
null要搜索的区域。归一化为
Circle。HTML 属性: location-restriction="radius@lat,lng" |
maxResultCount
attr: max-result-count |
输入类型:
number optional输出类型: number optional默认值:
null返回的结果数上限。
HTML 属性: max-result-count="number" |
rankPreference
attr: rank-preference |
默认值:
null回答中结果的排序方式。
HTML 属性: rank-preference="value-name" |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceNearbySearchRequestElementOptions 接口
接口
google.maps.places.PlaceNearbySearchRequestElementOptions
由 PlaceNearbySearchRequestElement 实现
“PlaceNearbySearchRequestElement”的选项。
PlaceTextSearchRequestElement 类
class
google.maps.places.PlaceTextSearchRequestElement
extends HTMLElement
implements PlaceTextSearchRequestElementOptions
library "places"
配置 PlaceSearchElement,以根据文本搜索请求加载结果。textQuery 属性是加载搜索元素所必需的。如果未设置 textQuery,系统将忽略任何其他已配置的属性。将此元素附加为 PlaceSearchElement 的子元素,以加载结果。例如:
<gmp-place-search>
<gmp-place-text-search-request
text-query="QUERY"
></gmp-place-text-search-request>
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
</gmp-place-search> <gmp-place-text-search-request ev-connector-types="ev-connector-type1 ev-connector-type2..." ev-minimum-charging-rate-kw="number" included-type="type" is-open-now location-bias="lat,lng" location-restriction="southwest-lat,southwest-lng|northeast-lat,northeast-lng" max-result-count="number" min-rating="number" price-levels="price-level1 price-level2..." rank-preference="value-name" text-query="string" use-strict-type-filtering> </gmp-place-text-search-request>
const {PlaceTextSearchRequestElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceTextSearchRequestElement |
PlaceTextSearchRequestElement([options])参数:
|
属性 | |
|---|---|
evConnectorTypes
attr: ev-connector-types |
默认值:
null首选电动汽车连接器类型列表。
HTML 属性: ev-connector-types="ev-connector-type1 ev-connector-type2..." |
evMinimumChargingRateKw
attr: ev-minimum-charging-rate-kw |
输入类型:
number optional输出类型: number optional默认值:
null最低充电速率要求(以千瓦为单位)。
HTML 属性: ev-minimum-charging-rate-kw="number" |
futureOpeningBusinessesIncluded |
输入类型:
boolean optional输出类型: boolean optional包含尚未开业但预计未来会开业的商家的地点联想查询。 |
includedType
attr: included-type |
输入类型:
string optional输出类型: string optional默认值:
null请求的地点类型。
HTML 属性: included-type="type" |
isOpenNow
attr: is-open-now |
输入类型:
boolean optional输出类型: boolean optional默认值:
null用于将搜索范围限制为当前营业的地点。
HTML 属性: is-open-now |
locationBias
attr: location-bias |
默认值:
null搜索的位置偏向。
HTML 属性:
|
locationRestriction
attr: location-restriction |
默认值:
null搜索的位置限制。归一化为
LatLngBounds。HTML 属性: location-restriction="southwest-lat,southwest-lng|northeast-lat,northeast-lng" |
maxResultCount
attr: max-result-count |
输入类型:
number optional输出类型: number optional默认值:
null返回的结果数上限。
HTML 属性: max-result-count="number" |
minRating
attr: min-rating |
输入类型:
number optional输出类型: number optional默认值:
null滤除平均房客评分严格低于此限制的结果。
HTML 属性: min-rating="number" |
priceLevels
attr: price-levels |
默认值:
null用于将搜索范围限制为标记为特定价格水平的地点。
HTML 属性: price-levels="price-level1 price-level2..." |
rankPreference
attr: rank-preference |
默认值:
null回答中结果的排序方式。
HTML 属性: rank-preference="value-name" |
textQuery
attr: text-query |
输入类型:
string optional输出类型: string optional默认值:
null文本搜索的文本查询。
HTML 属性: text-query="string" |
useStrictTypeFiltering
attr: use-strict-type-filtering |
输入类型:
boolean optional输出类型: boolean optional默认值:
null用于为“includedType”设置严格的类型过滤。
HTML 属性: use-strict-type-filtering |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceTextSearchRequestElementOptions 接口
接口
google.maps.places.PlaceTextSearchRequestElementOptions
由 PlaceTextSearchRequestElement 实现
“PlaceTextSearchRequestElement”的选项。
Autocomplete 类
class
google.maps.places.Autocomplete
extends MVCObject
library "places"
一个根据用户输入的文本提供地点联想查询的小部件。它会附加到 text 类型的输入元素,并监听该字段中的文本输入。预测结果列表会以一个下拉列表的形式呈现,并随着用户输入文本而更新。
const {Autocomplete} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
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)参数:
返回值:无
设置在成功检索到详情后,要在详情响应中为地点包含的字段。如需查看字段列表,请参阅 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
可选 |
类型:
LatLngBounds|LatLngBoundsLiteral optional要在其中搜索地点的区域。 |
componentRestrictions
可选 |
类型:
ComponentRestrictions optional组件限制。组件限制用于将预测结果限制在父组件内。例如,国家/地区。 |
fields
可选 |
类型:
Array<string> optional成功检索到详情后,详情响应中要包含的地点字段,这些字段将计费。如果传入的是 ['ALL'],系统会返回所有可用字段并据此计费(不建议用于生产环境中的部署)。如需查看字段列表,请参阅 PlaceResult。可以使用点路径(例如 "geometry.location")指定嵌套字段。默认值为 ['ALL']。 |
可选 |
类型:
boolean optional是否仅检索地点 ID。触发 place_changed 事件时提供的 PlaceResult 将仅包含 place_id、types 和 name 字段,以及自动补全服务返回的 place_id、types 和 description。默认情况下,该环境处于停用状态。 |
strictBounds
可选 |
类型:
boolean optional一个布尔值,表示自动补全 widget 应仅返回那些在发送查询时位于自动补全 widget 边界内的地点。将 strictBounds 设置为 false(默认值)会使结果偏向于(但不限于)边界内包含的地点。 |
types
可选 |
类型:
Array<string> optional要返回的联想查询类型。如需了解支持的类型,请参阅 开发者指南。如果未指定任何类型,系统将返回所有类型。 |
SearchBox 类
class
google.maps.places.SearchBox
extends MVCObject
library "places"
一种微件,可根据用户的文本输入提供联想查询。它会附加到 text 类型的输入元素,并监听该字段中的文本输入。预测结果列表会以一个下拉列表的形式呈现,并随着用户输入文本而更新。
const {SearchBox} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
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
可选 |
类型:
LatLngBounds|LatLngBoundsLiteral optional查询联想结果偏向的区域。联想查询偏向于(但不限于)针对这些边界的查询。 |
PlaceContextualElement 类
class
google.maps.places.PlaceContextualElement
extends HTMLElement
implements PlaceContextualElementOptions
library "places"
一个使用上下文 token 来显示 Grounding with Google Maps 回答的贴合情境的视图的微件。
<gmp-place-contextual context-token="string"> </gmp-place-contextual>
const {PlaceContextualElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceContextualElement |
PlaceContextualElement([options])参数:
|
属性 | |
|---|---|
contextToken
attr: context-token |
输入类型:
string optional输出类型: string optional上下文令牌。
HTML 属性: context-token="string" |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceContextualElementOptions 接口
接口
google.maps.places.PlaceContextualElementOptions
由 PlaceContextualElement 实现
“PlaceContextualElement”的选项。
属性 | |
|---|---|
contextToken
可选 |
类型:
string optionalGrounding with Google Maps 回答提供的上下文 token。 |
PlaceContextualListConfigElement 类
class
google.maps.places.PlaceContextualListConfigElement
extends HTMLElement
implements PlaceContextualListConfigElementOptions
library "places"
一个 HTML 元素,用于配置地点情境元素的列表视图选项。
<gmp-place-contextual-list-config layout="value-name" map-hidden> </gmp-place-contextual-list-config>
const {PlaceContextualListConfigElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlaceContextualListConfigElement |
PlaceContextualListConfigElement([options])参数:
|
属性 | |
|---|---|
layout
attr: layout |
布局。
HTML 属性: layout="value-name" |
mapHidden
attr: map-hidden |
输入类型:
boolean optional输出类型: boolean地图是否处于隐藏状态。
HTML 属性: map-hidden |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
PlaceContextualListConfigElementOptions 接口
接口
google.maps.places.PlaceContextualListConfigElementOptions
由 PlaceContextualListConfigElement 实现
PlaceContextualListConfigElement 的选项。
属性 | |
|---|---|
layout
可选 |
类型:
PlaceContextualListLayout optional布局。 |
mapHidden
可选 |
类型:
boolean optional默认值:
false如果应隐藏地图,则为 true。 |
PlaceContextualListLayout 常量
常量
google.maps.places.PlaceContextualListLayout
库 "places"
地点情境元素支持的列表视图布局列表。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 PlaceContextualListLayoutString 类型定义。
const {PlaceContextualListLayout} = await google.maps.importLibrary("places");
常量 | |
|---|---|
COMPACT |
紧凑列表布局:列表项在单行中呈现为链接,溢出项则显示在下拉列表中。 |
VERTICAL |
垂直列表布局:列表项在垂直列表中呈现为卡片。 |
PlacePinElement 类
class
google.maps.places.PlacePinElement
extends HTMLElement
implements PlacePinElementOptions
library "places"
使用地点的类别图标或照片显示地点的地图图钉。附加 PlaceDetailsPlaceRequestElement 或 PlaceDetailsLocationRequestElement 以指定地点。将图钉用作 AdvancedMarkerElement 的内容。3D 地图不支持此功能。
示例:
<gmp-advanced-marker>
<gmp-place-pin>
<gmp-place-details-place-request
place="PLACE_ID"
></gmp-place-details-place-request>
<gmp-place-rating></gmp-place-rating>
</gmp-place-pin>
</gmp-advanced-marker> 如需使用此元素,请在 Google Cloud 控制台中为您的项目启用 Places UI Kit API。
<gmp-place-pin icon="value-name" scale="number"> </gmp-place-pin>
const {PlacePinElement} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
PlacePinElement |
PlacePinElement([options])参数:
|
属性 | |
|---|---|
icon
attr: icon |
默认值:
PlacePinIcon.TYPE图钉内显示的图标。请参阅
PlacePinIcon。HTML 属性: icon="value-name" |
photoRendered
readonly |
类型:
boolean只读。如果图钉显示的是地点的照片,则为 True。如果 icon 不是 PHOTO,则始终为 false。如果 icon 为 PHOTO,但地点没有照片,或者照片加载失败,则此值为 false,并且图钉会改为显示地点类型图标。在 gmp-load 触发之前设置。 |
place
readonly |
类型:
Place optional只读。Place 对象,其中包含当前呈现的地点的 ID、位置和视口。如果地点尚未加载或加载失败,则为 undefined。 |
scale
attr: scale |
输入类型:
number optional输出类型: number默认值:
1图钉的大小倍数。
HTML 属性: scale="number" |
槽数 | |
|---|---|
default |
在图钉上显示的可选内容,例如 PlaceRatingElement、自定义 <span> 或文本。Light DOM 子级会直接插入到图钉中。内容显示的位置取决于 icon:对于 TYPE,显示在地点类型图标旁边;对于 PHOTO,显示为照片上的徽章;对于 NONE,显示为图钉的主要内容。 |
CSS 属性 | |
|---|---|
--gmp-background |
图钉的背景颜色:胶囊、相框、照片标记、尖角和地点类型图钉的边框。 |
--gmp-border-radius |
PHOTO 图钉中胶囊容器(包含槽位内容的位置类型图标,或仅包含槽位内容)和照片框的边框半径。默认情况下,对于包含插槽内容的地点类型图标,其大小为 30px;对于仅包含插槽内容的情况,其大小为 12px;对于照片框,其大小为 12px。不适用于不含插槽内容的地点类型图钉。 |
--gmp-glyph-background |
地点类型字形后面的背景颜色。默认值为地点的 iconBackgroundColor。 |
--gmp-glyph-color |
地点类型字形的颜色。在显示字形时应用,包括 PHOTO 图钉回退到地点类型图标时。 |
方法 | |
|---|---|
继承的方法:
addEventListener、removeEventListener
|
事件 | |
|---|---|
gmp-error |
function(event)参数:
当图钉根本无法呈现时,系统会触发此事件,例如由于网络故障、凭证故障(例如 API 密钥不正确)、无法解析的地点 ID 或没有位置信息的地点。图钉处于隐藏状态。此事件不会冒泡。 |
gmp-load |
function(event)参数:
加载地点详情并呈现图钉后,系统会触发此事件。当 icon 为 PHOTO 时,它仅在照片加载成功或失败后触发;仅照片加载失败不会触发 gmp-error。从 PlacePinElement.place 中读取加载的地点,并从 PlacePinElement.photoRendered 中读取是否显示照片。此事件不会冒泡。 |
PlacePinElementOptions 接口
接口
google.maps.places.PlacePinElementOptions
由 PlacePinElement 实现
用于构建 PlacePinElement 的选项。
属性 | |
|---|---|
icon
可选 |
类型:
PlacePinIcon optional请参阅 PlacePinElement.icon。 |
scale
可选 |
类型:
number optional |
PlacePinIcon 常量
常量
google.maps.places.PlacePinIcon
库 "places"
PlacePinElement的图标选项。默认为 TYPE。如果所选图标所需的数据缺失,图钉会回退到 TYPE。如果缺少 TYPE 所需的数据,系统会改为显示通用图标。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 PlacePinIconString 类型定义。
const {PlacePinIcon} = await google.maps.importLibrary("places");
常量 | |
|---|---|
NONE |
不显示图标,仅显示插槽内容。 |
PHOTO |
在圆圈中显示地点的照片。如果地点没有照片,则回退到 TYPE。 |
TYPE |
显示地点的类别图标。 |