Map View

JourneySharedMapView

google.maps.journeySharing.JourneySharingMapView

地图视图。

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

JourneySharingMapView
JourneySharingMapView(options)
参数
实例化地图视图。
anticipatedRoutePolylines
类型Array<Polyline>
返回预期的路线多段线(如果有)。
anticipatedRoutePolylineSetup
类型PolylineSetup
配置预期路线多段线的选项。每当渲染新的预期路线多段线时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultValueTrackOptions 字段(包含 google.maps.polylineOptions 对象),并将其作为输出 ValueTrackSetupOptions 对象中的 polylineOptions 返回。

指定 PolygonSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 PolygonSetup 函数或静态值中重复使用同一个 polylineSetupOptions 对象,也不得为不同 polylineSetupOptions 对象中的 polylineOptions 键重复使用同一个 google.maps.polylineOptions 对象。如果 polylineOptions 或 visible 未设置或为 null,它将被默认值覆盖。系统会忽略为 polylineOptions.map 或 polylineOptions.path 设置的任何值。
automaticViewportMode
此字段是只读的。自动视口模式。
element
类型Element
此字段是只读的。支持视图的 DOM 元素。
enableTraffic
类型boolean
启用或停用路况图层。
locationProviders
类型Array<LocationProvider> optional
此字段是只读字段。要在跟踪地图视图中显示的跟踪营业地点的来源。如需添加或移除位置信息提供程序,请使用 JourneySharingMapView.addLocationProviderJourneySharingMapView.removeLocationProvider 方法。
map
类型Map
此字段是只读的。地图视图中包含的地图对象。
mapOptions
类型MapOptions
此字段是只读的。通过地图视图传入地图的地图选项。
takenRoutePolylines
类型Array<Polyline>
返回采用的路线多段线(如果有)。
takenRoutePolylineSetup
类型PolylineSetup
配置已采用的路线多段线的选项。每当渲染新的采用路线多段线时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultValueTrackOptions 字段(包含 google.maps.polylineOptions 对象),并将其作为输出 ValueTrackSetupOptions 对象中的 polylineOptions 返回。

指定 PolygonSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 PolygonSetup 函数或静态值中重复使用同一个 polylineSetupOptions 对象,也不得为不同 polylineSetupOptions 对象中的 polylineOptions 键重复使用同一个 google.maps.polylineOptions 对象。

为 polylineOptions.map 或 polylineOptions.path 设置的任何值都将被忽略。任何未设置或 null 的值都将被默认值覆盖。
locationProvider
类型LocationProvider optional
此字段是只读的。要在跟踪地图视图中显示的所跟踪位置的来源。
destinationMarkerSetup
类型MarkerSetup
配置目的地位置标记的选项。每当渲染新的目的地标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
originMarkerSetup
类型MarkerSetup
配置出发地位置标记的选项。每当渲染新的出发地标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
pingMarkerSetup
类型MarkerSetup
配置 ping 位置标记的选项。每当渲染新的 ping 标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
successfulTaskMarkerSetup
类型MarkerSetup
配置成功任务位置标记的选项。每当渲染新的成功任务标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
taskOutcomeMarkerSetup
类型MarkerSetup
配置任务结果位置标记的选项。每当渲染新的任务结果位置标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
unsuccessfulTaskMarkerSetup
类型MarkerSetup
配置不成功任务位置标记的选项。每当渲染新的失败任务标记时被调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
vehicleMarkerSetup
类型MarkerSetup
配置车辆位置标记的选项。每当渲染新的车辆标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
waypointMarkerSetup
类型MarkerSetup
配置航点位置标记的选项。每当渲染新的航点标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
destinationMarkers
类型Array<Marker>
返回目的地标记(如果有)。
originMarkers
类型Array<Marker>
返回起点标记(如果有)。
successfulTaskMarkers
类型Array<Marker>
返回成功的任务标记(如果有)。
taskOutcomeMarkers
类型Array<Marker>
返回任务结果标记(如果有)。
unsuccessfulTaskMarkers
类型Array<Marker>
返回失败的任务标记(如果有)。
vehicleMarkers
类型Array<Marker>
返回车辆标记(如果有)。
waypointMarkers
类型Array<Marker>
返回航点标记(如果有)。
addLocationProvider
addLocationProvider(locationProvider)
参数
返回值:无
向地图视图添加位置提供程序。如果已添加位置信息提供程序,则无需执行任何操作。
removeLocationProvider
removeLocationProvider(locationProvider)
参数
返回值:无
从地图视图中移除位置信息提供程序。如果位置提供程序尚未添加到地图视图中,则不执行任何操作。

JourneySharedMapViewOptions 界面

google.maps.journeySharing.JourneySharingMapViewOptions 接口

地图视图的选项。

element
类型Element
支持视图的 DOM 元素。必填。
anticipatedRoutePolylineSetup optional
类型PolylineSetup optional
配置预期路线多段线的选项。每当渲染新的预期路线多段线时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultValueTrackOptions 字段(包含 google.maps.polylineOptions 对象),并将其作为输出 ValueTrackSetupOptions 对象中的 polylineOptions 返回。

指定 PolygonSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 PolygonSetup 函数或静态值中重复使用同一个 polylineSetupOptions 对象,也不得为不同 polylineSetupOptions 对象中的 polylineOptions 键重复使用同一个 google.maps.polylineOptions 对象。如果 polylineOptions 或 visible 未设置或为 null,它将被默认值覆盖。系统会忽略为 polylineOptions.map 或 polylineOptions.path 设置的任何值。
automaticViewportMode optional
类型AutomaticViewportMode optional
自动视口模式。默认值为 FIT_ANTICIPATED_ROUTE,这样可以让地图视图自动调整视口,以适应车辆标记、位置标记和任何可见的预期路线多段线。将此项设置为“无”可关闭自动调整功能。
destinationMarkerSetup optional
类型MarkerSetup optional
配置目的地位置标记的选项。每当渲染新的目的地标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
locationProvider optional
类型LocationProvider optional
要在跟踪地图视图中显示的所跟踪位置的来源。可选。
locationProviders optional
类型Array<LocationProvider> optional
要在跟踪地图视图中显示的跟踪营业地点的来源。可选。
mapOptions optional
类型MapOptions optional
传递到 google.maps.Map 构造函数的地图选项。
originMarkerSetup optional
类型MarkerSetup optional
配置出发地位置标记的选项。每当渲染新的出发地标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
pingMarkerSetup optional
类型MarkerSetup optional
配置 ping 位置标记的选项。每当渲染新的 ping 标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
successfulTaskMarkerSetup optional
类型MarkerSetup optional
配置成功任务位置标记的选项。每当渲染新的成功任务标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
takenRoutePolylineSetup optional
类型PolylineSetup optional
配置已采用的路线多段线的选项。每当渲染新的采用路线多段线时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultValueTrackOptions 字段(包含 google.maps.polylineOptions 对象),并将其作为输出 ValueTrackSetupOptions 对象中的 polylineOptions 返回。

指定 PolygonSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 PolygonSetup 函数或静态值中重复使用同一个 polylineSetupOptions 对象,也不得为不同 polylineSetupOptions 对象中的 polylineOptions 键重复使用同一个 google.maps.polylineOptions 对象。

为 polylineOptions.map 或 polylineOptions.path 设置的任何值都将被忽略。任何未设置或 null 的值都将被默认值覆盖。
taskOutcomeMarkerSetup optional
类型MarkerSetup optional
配置任务结果位置标记的选项。每当渲染新的任务结果位置标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
unsuccessfulTaskMarkerSetup optional
类型MarkerSetup optional
配置不成功任务位置标记的选项。每当渲染新的失败任务标记时被调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
vehicleMarkerSetup optional
类型MarkerSetup optional
配置车辆位置标记的选项。每当渲染新的车辆标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。
waypointMarkerSetup optional
类型MarkerSetup optional
配置航点位置标记的选项。每当渲染新的航点标记时调用。

如果指定了一个函数,该函数可以而且应该修改输入的 defaultMarkerOptions 字段(包含 google.maps.MarkerOptions 对象),并在输出 MarkerSetupOptions 对象中将其作为 tagsOptions 返回。

指定 MarkerSetupOptions 对象与指定返回该静态对象的函数具有相同的效果。

请勿在不同的 MarkerSetup 函数或静态值中重复使用相同的 MarkerSetupOptions 对象,也不要将相同的 google.maps.MarkerOptions 对象重复用于不同 MarkerSetupOptions 对象中的 markOptions 键。如果 tagOptions 未设置或 null,则会被默认值覆盖。系统会忽略针对 tagsOptions.map 或 markerOptions.position 设置的任何值。

AutomaticViewportMode 常量

google.maps.journeySharing.AutomaticViewportMode 常量

自动视口模式。

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

FIT_ANTICIPATED_ROUTE 自动调整视口以适应标记和任何可见的预期路线多段线。这是默认值。
NONE 不自动调整视口。

LocationProvider 抽象类

google.maps.journeySharing.LocationProvider 抽象类

所有位置信息提供程序的父类。

addListener
addListener(eventName, handler)
参数
  • eventNamestring 要监听的事件的名称。
  • handlerFunction 事件处理脚本。
返回值MapsEventListener
为由此位置信息提供程序触发的事件添加 MapsEventListener。返回此监听器的标识符,该标识符可与 event.removeListener 配合使用。

PollingLocationProvider 抽象类

google.maps.journeySharing.PollingLocationProvider 抽象类

轮询位置提供程序的父级类。

此抽象类扩展了 LocationProvider

isPolling
类型boolean
如果此位置信息提供程序正在进行轮询,则为 true。只读。
pollingIntervalMillis
类型number
获取位置信息更新的最短时间(以毫秒为单位)。如果获取位置信息更新所需的时间超过 pollingIntervalMillis,则在当前更新完成之前,下一次位置信息更新不会开始。

将此值设置为 0、无限值或负值会停用位置信息自动更新。如果跟踪 ID 参数(例如配送位置提供商的配送跟踪 ID)或过滤选项(例如舰队位置提供商的视口边界或属性过滤条件)发生变化,系统会提取一次新的营业地点更新。

默认的轮询时间间隔为 5000 毫秒,最小时间间隔为 5000 毫秒。如果您将轮询间隔设置为较小的正值,则会存储和使用 5000。
继承的设置addListener
ispollingchange
function(event)
在位置信息提供程序的轮询状态更新时触发的事件。使用 PollingLocationProvider.isPolling 确定当前的轮询状态。

PollingLocationProviderIsPollingChangeEvent 接口

google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent 接口

触发 PollingLocationProvider.ispollingchange 事件时传递给事件处理脚本的事件对象。

error optional
类型Error optional
导致轮询状态发生更改的错误(如果状态更改是由错误导致的)。未定义是否由正常操作引起状态变化。