JourneySharingMapView 类
google.maps.journeySharing.JourneySharingMapView
class
library "journeySharing"
地图视图。
const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing");
构造函数 | |
|---|---|
JourneySharingMapView |
JourneySharingMapView(options)参数:
实例化地图视图。 |
属性 | |
|---|---|
automaticViewportMode |
此字段为只读字段。自动视口模式。 |
element |
类型:
Element此字段为只读字段。支持视图的 DOM 元素。 |
enableTraffic |
类型:
boolean启用或停用路况图层。 |
locationProviders |
类型:
Array<LocationProvider> optional此字段为只读字段。要在跟踪地图视图中显示的跟踪位置的来源。如需添加或移除位置信息提供程序,请使用 JourneySharingMapView.addLocationProvider 和 JourneySharingMapView.removeLocationProvider 方法。 |
map |
类型:
Map此字段为只读字段。地图视图中包含的地图对象。 |
mapOptions |
类型:
MapOptions此字段为只读字段。通过地图视图传递到地图中的地图选项。 |
|
类型:
LocationProvider optional此字段为只读字段。要在跟踪地图视图中显示的跟踪位置的来源。 |
|
类型:
MarkerSetup配置目的地位置标记的选项。每当渲染新的目的地标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup配置起点位置标记的选项。每当渲染新的起点标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup配置任务结果位置标记的选项。每当呈现新的任务结果位置标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup为失败的任务位置标记配置选项。每当呈现新的不成功任务标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup配置车辆位置标记的选项。每当渲染新的车辆标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup配置航点位置标记的选项。每当渲染新的航点标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
配置预期路线多段线的选项。每当渲染新的预期路线多段线时调用。 如果指定函数,该函数可以且应该修改输入的 defaultPolylineOptions 字段(其中包含 google.maps.PolylineOptions 对象),并将其作为 polylineOptions 在输出 PolylineSetupOptions 对象中返回。 指定 PolylineSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 PolylineSetup 函数或静态值中重复使用同一个 PolylineSetupOptions 对象,也不要在不同的 PolylineSetupOptions 对象中为 polylineOptions 键重复使用同一个 google.maps.PolylineOptions 对象。如果 polylineOptions 或 visible 未设置或为 null,则会被默认值覆盖。为 polylineOptions.map 或 polylineOptions.path 设置的所有值都将被忽略。 |
|
配置已选路线多段线的选项。每当渲染新的已行驶路线多段线时调用。 如果指定函数,该函数可以且应该修改输入的 defaultPolylineOptions 字段(其中包含 google.maps.PolylineOptions 对象),并将其作为 polylineOptions 在输出 PolylineSetupOptions 对象中返回。 指定 PolylineSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 PolylineSetup 函数或静态值中重复使用同一个 PolylineSetupOptions 对象,也不要在不同的 PolylineSetupOptions 对象中为 polylineOptions 键重复使用同一个 google.maps.PolylineOptions 对象。 为 polylineOptions.map 或 polylineOptions.path 设置的所有值都将被忽略。任何未设置的值或 null 值都将被默认值覆盖。 |
|
类型:
MarkerSetup配置 ping 位置标记的选项。每当渲染新的 ping 标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
类型:
MarkerSetup配置成功任务位置标记的选项。每当渲染新的成功任务标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
|
返回目的地标记(如果有)。 |
|
返回起点标记(如果有)。 |
|
返回成功的任务标记(如果有)。 |
|
返回任务结果标记(如果有)。 |
|
返回失败的任务标记(如果有)。 |
|
返回车辆标记(如果有)。 |
|
返回航点标记(如果有)。 |
|
返回预期的路线多段线(如果有)。 |
|
返回所选路线的多段线(如果有)。 |
方法 | |
|---|---|
addLocationProvider |
addLocationProvider(locationProvider)参数:
返回值:无
向地图视图添加位置信息提供程序。如果位置信息提供程序已添加,则不执行任何操作。 |
removeLocationProvider |
removeLocationProvider(locationProvider)参数:
返回值:无
从地图视图中移除位置信息提供程序。如果位置信息提供程序尚未添加到地图视图中,则不会执行任何操作。 |
JourneySharingMapViewOptions 接口
google.maps.journeySharing.JourneySharingMapViewOptions
接口
地图视图的选项。
属性 | |
|---|---|
element |
类型:
Element支持视图的 DOM 元素。必填。 |
可选 |
类型:
PolylineSetup optional配置预期路线多段线的选项。每当渲染新的预期路线多段线时调用。 如果指定函数,该函数可以且应该修改输入的 defaultPolylineOptions 字段(其中包含 google.maps.PolylineOptions 对象),并将其作为 polylineOptions 在输出 PolylineSetupOptions 对象中返回。 指定 PolylineSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 PolylineSetup 函数或静态值中重复使用同一个 PolylineSetupOptions 对象,也不要在不同的 PolylineSetupOptions 对象中为 polylineOptions 键重复使用同一个 google.maps.PolylineOptions 对象。如果 polylineOptions 或 visible 未设置或为 null,则会被默认值覆盖。为 polylineOptions.map 或 polylineOptions.path 设置的所有值都将被忽略。 |
automaticViewportMode
可选 |
类型:
AutomaticViewportMode optional自动视口模式。默认值为 FIT_ANTICIPATED_ROUTE,这会使地图视图自动调整视口,以适应车辆标记、位置标记和任何可见的预期路线多段线。将此属性设置为 NONE 可关闭自动调整功能。 |
可选 |
类型:
MarkerSetup optional配置目的地位置标记的选项。每当渲染新的目的地标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
LocationProvider optional要在跟踪地图视图中显示的跟踪位置的来源。可选。 |
locationProviders
可选 |
类型:
Array<LocationProvider> optional要在跟踪地图视图中显示的跟踪位置的来源。可选。 |
mapOptions
可选 |
类型:
MapOptions optional传递到 google.maps.Map 构造函数的地图选项。 |
可选 |
类型:
MarkerSetup optional配置起点位置标记的选项。每当渲染新的起点标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
MarkerSetup optional配置 ping 位置标记的选项。每当渲染新的 ping 标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
MarkerSetup optional配置成功任务位置标记的选项。每当渲染新的成功任务标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
PolylineSetup optional配置已选路线多段线的选项。每当渲染新的已行驶路线多段线时调用。 如果指定函数,该函数可以且应该修改输入的 defaultPolylineOptions 字段(其中包含 google.maps.PolylineOptions 对象),并将其作为 polylineOptions 在输出 PolylineSetupOptions 对象中返回。 指定 PolylineSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 PolylineSetup 函数或静态值中重复使用同一个 PolylineSetupOptions 对象,也不要在不同的 PolylineSetupOptions 对象中为 polylineOptions 键重复使用同一个 google.maps.PolylineOptions 对象。 为 polylineOptions.map 或 polylineOptions.path 设置的所有值都将被忽略。任何未设置的值或 null 值都将被默认值覆盖。 |
可选 |
类型:
MarkerSetup optional配置任务结果位置标记的选项。每当呈现新的任务结果位置标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
MarkerSetup optional为失败的任务位置标记配置选项。每当呈现新的不成功任务标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
MarkerSetup optional配置车辆位置标记的选项。每当渲染新的车辆标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
可选 |
类型:
MarkerSetup optional配置航点位置标记的选项。每当渲染新的航点标记时调用。 如果指定函数,该函数可以且应该修改输入的 defaultMarkerOptions 字段(其中包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 markerOptions 返回。 指定 MarkerSetupOptions 对象的效果与指定返回该静态对象的函数的效果相同。 请勿在不同的 MarkerSetup 函数或静态值中重复使用同一个 MarkerSetupOptions 对象,也不要在不同的 MarkerSetupOptions 对象中为 markerOptions 键重复使用同一个 google.maps.MarkerOptions 对象。如果 markerOptions 未设置或为 null,则会被默认值覆盖。为 markerOptions.map 或 markerOptions.position 设置的任何值都将被忽略。 |
AutomaticViewportMode 常量
google.maps.journeySharing.AutomaticViewportMode
常量
库 "journeySharing"
自动视口模式。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 AutomaticViewportModeString 类型定义。
const {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing");
常量 | |
|---|---|
FIT_ANTICIPATED_ROUTE |
自动调整视口,以适应标记和任何可见的预期路线多段线。这是默认值。 |
NONE |
不自动调整视口。 |
LocationProvider 抽象类
google.maps.journeySharing.LocationProvider
抽象类
所有位置信息提供程序的父类。
方法 | |
|---|---|
addListener |
addListener(eventName, handler)参数:
为由此位置信息提供程序触发的事件添加 MapsEventListener。返回此监听器的标识符,该标识符可与 event.removeListener 搭配使用。 |
PollingLocationProvider 抽象类
google.maps.journeySharing.PollingLocationProvider
abstract class
extends LocationProvider
投票地点提供程序的父类。
属性 | |
|---|---|
isPolling |
类型:
boolean如果此位置信息提供程序正在轮询,则为 true。只读。 |
pollingIntervalMillis |
类型:
number两次获取位置信息更新之间的最短时间间隔(以毫秒为单位)。如果获取位置信息更新的时间超过 pollingIntervalMillis,则在当前位置信息更新完成之前,系统不会启动下一次位置信息更新。将此值设置为 0、无穷大或负值会停用自动位置信息更新。如果跟踪 ID 参数(例如,配送位置信息提供方的配送跟踪 ID)或过滤选项(例如,车队位置信息提供方的视口边界或属性过滤条件)发生变化,系统会获取一次新的位置信息更新。 默认和最小轮询间隔为 5000 毫秒。如果您将轮询间隔设置为较小的正值,系统会存储并使用 5000。 |
方法 | |
|---|---|
继承:
addListener
|
事件 | |
|---|---|
ispollingchange |
function(event)在位置信息提供程序的轮询状态更新时触发的事件。使用 PollingLocationProvider.isPolling 确定当前轮询状态。 |
PollingLocationProviderIsPollingChangeEvent 接口
google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent
接口
触发 PollingLocationProvider.ispollingchange 事件时传递给事件处理脚本的事件对象。
属性 | |
|---|---|
error
可选 |
类型:
Error optional导致轮询状态发生变化的错误(如果状态变化是由错误引起的)。如果状态更改是由于正常操作引起的,则未定义。 |