LocalContextMapView 类
google.maps.localContext.LocalContextMapView
类
使用 Map
显示 Local Context 体验。
此类实现了 LocalContextMapViewOptions
。
通过调用 const {LocalContextMapView} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
LocalContextMapView |
LocalContextMapView(options) 参数:
|
属性 | |
---|---|
directionsOptions |
类型:
MapDirectionsOptions|MapDirectionsOptionsLiteral optional |
element optional |
类型:
HTMLElement|SVGElement optional 此字段为只读字段。为视图提供后备的 DOM 元素。 |
isTransitioningMapBounds |
类型:
boolean 在 LocalContextMapView 开始更改内部 Map 的边界之前设置为 true ,在 LocalContextMapView 完成更改内部 Map 的边界之后设置为 false 。(当布局模式因响应式调整大小而发生变化时,不会设置此值。) |
locationBias |
类型:
LocationBias optional 请参阅 LocalContextMapViewOptions.locationBias 。更改 LocalContextMapView 上的此属性可能会触发新的搜索。 |
locationRestriction |
类型:
LocationRestriction optional 请参阅 LocalContextMapViewOptions.locationRestriction 。更改 LocalContextMapView 上的此属性可能会触发新的搜索。 |
maxPlaceCount |
类型:
number 请参阅 LocalContextMapViewOptions.maxPlaceCount 。更改 LocalContextMapView 上的此属性可能会触发新的搜索。 |
placeTypePreferences |
类型:
Array<PlaceTypePreference> 请参阅 LocalContextMapViewOptions.placeTypePreferences 。更改 LocalContextMapView 上的此属性可能会触发新的搜索。也可以使用 Iterable<string|PlaceTypePreference> 。 |
继承自:map 、pinOptionsSetup 、placeChooserViewSetup 、placeDetailsViewSetup
|
方法 | |
---|---|
addListener |
addListener(eventName, handler) 参数:
返回值:
MapsEventListener 将指定的监听器函数添加到指定的事件名称。 |
hidePlaceDetailsView |
hidePlaceDetailsView() 参数:无
返回值:None
隐藏地点详情。 |
search |
search() 参数:无
返回值:None
根据当前的 maxPlaceCount 、placeTypePreferences 、locationRestriction 和 locationBias 搜索要向用户显示的地点。 |
事件 | |
---|---|
error |
function(event) 参数:
如果执行搜索时发生错误,系统会触发此事件。 |
placedetailsviewhidestart |
function() 参数:None
此事件会在地点详情开始动画退出之前触发。 |
placedetailsviewshowstart |
function() 参数:None
此事件会在地点详情开始动画呈现之前触发。 |
LocalContextMapViewOptions 接口
google.maps.localContext.LocalContextMapViewOptions
接口
用于构建 LocalContextMapView
或访问现有 LocalContextMapView
的选项。
属性 | |
---|---|
maxPlaceCount |
类型:
number 要显示的地点的数量上限。当此参数为 0 时,Local Context Library 不会加载地点。[0,24] |
placeTypePreferences |
类型:
Array<PlaceTypePreference> 要搜索的地点类型(最多 10 个)。系统也接受 Iterable<string|PlaceTypePreference> 类型,但仅在原生支持 JavaScript 符号的浏览器中受支持。 |
directionsOptions optional |
类型:
MapDirectionsOptions|MapDirectionsOptionsLiteral optional 用于自定义路线的选项。如果未设置,系统将停用方向和距离。 |
element optional |
类型:
HTMLElement|SVGElement optional 此字段为只读字段。为视图提供后备的 DOM 元素。 |
locationBias optional |
类型:
LocationBias optional 默认值:
null 搜索地点时使用的软边界或提示。 |
locationRestriction optional |
类型:
LocationRestriction optional 用于限制搜索结果的边界。如果未指定,结果将限定在地图视口内。 |
map optional |
类型:
Map optional 已实例化的 Map 实例。如果传入,地图将移至 LocalContextMapView 的 DOM,并且不会重新设置样式。与地图关联的元素可能还会由 LocalContextMapView 应用样式和类。 |
pinOptionsSetup optional |
类型:
(function({ 根据图标状态配置地点标记图标。每当回调的输入发生变化时都会调用。在 LocalContextMapView 绘制地点标记时,传递一个函数以动态替换默认设置。系统可能会异步确定错误和无效配置,并将其忽略(系统会使用默认值,并将错误记录到控制台)。 |
placeChooserViewSetup optional |
类型:
(function({ 替换地点选择器视图的设置。当 LocalContextMapView 可能会因调整大小而更改其布局时,传递一个函数以动态替换默认设置。系统可能会异步确定错误和无效配置,并将其忽略(系统会改用默认值,并将错误记录到控制台)。在构建时检测到的错误将导致同步抛出错误。 |
placeDetailsViewSetup optional |
类型:
(function({ 替换地点详情视图的设置。当 LocalContextMapView 可能会因调整大小而更改其布局时,传递一个函数以动态替换默认设置。系统可能会异步确定错误和无效配置,并将其忽略(系统会使用默认值,并将错误记录到控制台)。在构建时检测到的错误将导致同步抛出错误。 |
PlaceTypePreference typedef
google.maps.localContext.PlaceTypePreference
typedef
要搜索的地点类型和要使用的权重。如果省略 weight
,则默认权重将由库来确定,并且可能会随着时间推移而发生变化和不断完善。
{
type:string,
weight:number optional
}
MapDirectionsOptions 类
google.maps.localContext.MapDirectionsOptions
类
使用 LocalContextMapView
为路线提供设置。
此类实现了 MapDirectionsOptionsLiteral
。
通过调用 const {MapDirectionsOptions} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
属性 | |
---|---|
继承:
origin
|
方法 | |
---|---|
addListener |
addListener(eventName, handler) 参数:
返回值:
MapsEventListener 将指定的监听器函数添加到指定的事件名称。 |
MapDirectionsOptionsLiteral 接口
google.maps.localContext.MapDirectionsOptionsLiteral
接口
为方便起见,在许多地方都接受使用对象字面量来代替 MapDirectionsOptions
对象。当 Maps API 遇到这些对象时,会将其转换为 MapDirectionsOptions
对象。
属性 | |
---|---|
origin |
类型:
LatLng|LatLngLiteral 路线和距离的起点。 |
PinOptions 接口
google.maps.localContext.PinOptions
接口
用于自定义图钉标记的选项。
属性 | |
---|---|
background optional |
类型:
string optional 图标形状的颜色,可以是任何有效的 CSS 颜色。 |
glyphColor optional |
类型:
string optional 图标字形的颜色可以是任何有效的 CSS 颜色。 |
scale optional |
类型:
number optional 图标的比例。此值是绝对值,而不是相对于各个状态的默认大小。 |
PlaceChooserViewSetupOptions 接口
google.maps.localContext.PlaceChooserViewSetupOptions
接口
地点选择器的设置选项。详细了解如何设置布局和公开范围。
属性 | |
---|---|
layoutMode optional |
类型:
PlaceChooserLayoutMode optional |
position optional |
类型:
PlaceChooserPosition optional 当 layoutMode:HIDDEN 时,系统会忽略此参数。如果未传递,系统会根据 layoutMode 自动确定位置。 |
PlaceChooserLayoutMode 常量
google.maps.localContext.PlaceChooserLayoutMode
常量
地点选择器的布局模式。
通过调用 const {PlaceChooserLayoutMode} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
常量 | |
---|---|
HIDDEN |
地点选择器处于隐藏状态。 |
SHEET |
地点选择器显示为工作表。 |
PlaceChooserPosition 常量
google.maps.localContext.PlaceChooserPosition
常量
地点选择器的显示位置。
通过调用 const {PlaceChooserPosition} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
常量 | |
---|---|
BLOCK_END |
地点选择器显示在地图下方的一行中,并延伸到容器的末尾。 |
INLINE_END |
地点选择器会与地图一起显示在线条末尾。(对于从左到右书写的语言,这意味着地点选择器位于地图右侧。) |
INLINE_START |
地点选择器会与地图一起显示在线条的起点处。(对于从左到右书写的语言,这意味着地点选择器位于地图左侧。) |
PlaceDetailsViewSetupOptions 接口
google.maps.localContext.PlaceDetailsViewSetupOptions
接口
地点详情的设置选项。详细了解如何设置布局和公开范围。
属性 | |
---|---|
hidesOnMapClick optional |
类型:
boolean optional |
layoutMode optional |
类型:
PlaceDetailsLayoutMode optional |
position optional |
类型:
PlaceDetailsPosition optional 当 layoutMode:INFO_WINDOW 时,系统会忽略此参数。如果未传递,系统会根据 layoutMode 自动确定位置。 |
PlaceDetailsLayoutMode 常量
google.maps.localContext.PlaceDetailsLayoutMode
常量
地点详情的布局模式。
通过调用 const {PlaceDetailsLayoutMode} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
常量 | |
---|---|
INFO_WINDOW |
地点详情显示在 InfoWindow 中。 |
SHEET |
地点详情显示在工作表中。 |
PlaceDetailsPosition 常量
google.maps.localContext.PlaceDetailsPosition
常量
显示地点详情的显示位置。
通过调用 const {PlaceDetailsPosition} = await google.maps.importLibrary("localContext")
进行访问。请参阅 Maps JavaScript API 中的库。
常量 | |
---|---|
INLINE_END |
地点详情会与地图一起显示在线条末尾。(对于从左到右书写的语言,这意味着地点详情位于地图右侧。) |
INLINE_START |
地点详情会在线路起点处与地图一起显示。(对于从左到右书写的语言,这意味着地点详情位于地图左侧。) |