Map View

JourneySharingMapView class

google.maps.journeySharing.JourneySharingMapView class

The map view.

Access by calling const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing").
See Libraries in the Maps JavaScript API.

Constructor
`JourneySharingMapView`	`JourneySharingMapView(options)` Parameters: `options`: `JourneySharingMapViewOptions` Options for the map view. Instantiates a map view.

Constructor

JourneySharingMapView

JourneySharingMapView(options)

Parameters:

options: JourneySharingMapViewOptions Options for the map view.

Instantiates a map view.

Properties
`automaticViewportMode`	Type: `AutomaticViewportMode` This Field is read-only. Automatic viewport mode.
`element`	Type: `Element` This Field is read-only. The DOM element backing the view.
`enableTraffic`	Type: `boolean` Enables or disables the traffic layer.
`locationProviders`	Type: `Array<LocationProvider> optional` This field is read-only. Sources of tracked locations to be shown in the tracking map view. To add or remove location providers, use the `JourneySharingMapView.addLocationProvider` and `JourneySharingMapView.removeLocationProvider` methods.
`map`	Type: `Map` This Field is read-only. The map object contained in the map view.
`mapOptions`	Type: `MapOptions` This Field is read-only. The map options passed into the map via the map view.
`locationProvider`	Type: `LocationProvider optional` This Field is read-only. A source of tracked locations to be shown in the tracking map view.
`destinationMarkerSetup`	Type: `MarkerSetup` Configures options for a destination location marker. Invoked whenever a new destination marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`originMarkerSetup`	Type: `MarkerSetup` Configures options for an origin location marker. Invoked whenever a new origin marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`taskOutcomeMarkerSetup`	Type: `MarkerSetup` Configures options for a task outcome location marker. Invoked whenever a new task outcome location marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`unsuccessfulTaskMarkerSetup`	Type: `MarkerSetup` Configures options for an unsuccessful task location marker. Invoked whenever a new unsuccessful task marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`vehicleMarkerSetup`	Type: `MarkerSetup` Configures options for a vehicle location marker. Invoked whenever a new vehicle marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`waypointMarkerSetup`	Type: `MarkerSetup` Configures options for a waypoint location marker. Invoked whenever a new waypoint marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`anticipatedRoutePolylineSetup`	Type: `PolylineSetup` Configures options for an anticipated route polyline. Invoked whenever a new anticipated route polyline is rendered. If specifying a function, the function can and should modify the input's defaultPolylineOptions field containing a google.maps.PolylineOptions object, and return it as polylineOptions in the output PolylineSetupOptions object. Specifying a PolylineSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same PolylineSetupOptions object in different PolylineSetup functions or static values, and do not reuse the same google.maps.PolylineOptions object for the polylineOptions key in different PolylineSetupOptions objects. If polylineOptions or visible is unset or null, it will be overwritten with the default. Any values set for polylineOptions.map or polylineOptions.path will be ignored.
`takenRoutePolylineSetup`	Type: `PolylineSetup` Configures options for a taken route polyline. Invoked whenever a new taken route polyline is rendered. If specifying a function, the function can and should modify the input's defaultPolylineOptions field containing a google.maps.PolylineOptions object, and return it as polylineOptions in the output PolylineSetupOptions object. Specifying a PolylineSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same PolylineSetupOptions object in different PolylineSetup functions or static values, and do not reuse the same google.maps.PolylineOptions object for the polylineOptions key in different PolylineSetupOptions objects. Any values set for polylineOptions.map or polylineOptions.path will be ignored. Any unset or null value will be overwritten with the default.
`pingMarkerSetup`	Type: `MarkerSetup` Configures options for a ping location marker. Invoked whenever a new ping marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`successfulTaskMarkerSetup`	Type: `MarkerSetup` Configures options for a successful task location marker. Invoked whenever a new successful task marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`destinationMarkers`	Type: `Array<Marker>` Returns the destination markers, if any.
`originMarkers`	Type: `Array<Marker>` Returns the origin markers, if any.
`successfulTaskMarkers`	Type: `Array<Marker>` Returns the successful task markers, if any.
`taskOutcomeMarkers`	Type: `Array<Marker>` Returns the task outcome markers, if any.
`unsuccessfulTaskMarkers`	Type: `Array<Marker>` Returns the unsuccessful task markers, if any.
`vehicleMarkers`	Type: `Array<Marker>` Returns the vehicle markers, if any.
`waypointMarkers`	Type: `Array<Marker>` Returns the waypoint markers, if any.
`anticipatedRoutePolylines`	Type: `Array<Polyline>` Returns the anticipated route polylines, if any.
`takenRoutePolylines`	Type: `Array<Polyline>` Returns the taken route polylines, if any.

Methods
`addLocationProvider`	`addLocationProvider(locationProvider)` Parameters: `locationProvider`: `LocationProvider` the location provider to add. Return Value: None Adds a location provider to the map view. If the location provider is already added, no action is performed.
`removeLocationProvider`	`removeLocationProvider(locationProvider)` Parameters: `locationProvider`: `LocationProvider` the location provider to remove. Return Value: None Removes a location provider from the map view. If the location provider is not already added to the map view, no action is performed.

Methods

addLocationProvider

addLocationProvider(locationProvider)

Parameters:

locationProvider: LocationProvider the location provider to add.

Return Value: None

Adds a location provider to the map view. If the location provider is already added, no action is performed.

removeLocationProvider

removeLocationProvider(locationProvider)

Parameters:

locationProvider: LocationProvider the location provider to remove.

Return Value: None

Removes a location provider from the map view. If the location provider is not already added to the map view, no action is performed.

JourneySharingMapViewOptions interface

google.maps.journeySharing.JourneySharingMapViewOptions interface

Options for the map view.

Properties
`element`	Type: `Element` The DOM element backing the view. Required.
`anticipatedRoutePolylineSetup optional`	Type: `PolylineSetup optional` Configures options for an anticipated route polyline. Invoked whenever a new anticipated route polyline is rendered. If specifying a function, the function can and should modify the input's defaultPolylineOptions field containing a google.maps.PolylineOptions object, and return it as polylineOptions in the output PolylineSetupOptions object. Specifying a PolylineSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same PolylineSetupOptions object in different PolylineSetup functions or static values, and do not reuse the same google.maps.PolylineOptions object for the polylineOptions key in different PolylineSetupOptions objects. If polylineOptions or visible is unset or null, it will be overwritten with the default. Any values set for polylineOptions.map or polylineOptions.path will be ignored.
`automaticViewportMode optional`	Type: `AutomaticViewportMode optional` Automatic viewport mode. Default value is FIT_ANTICIPATED_ROUTE, which enables the map view to automatically adjust the viewport to fit vehicle markers, location markers, and any visible anticipated route polylines. Set this to NONE to turn off automatic fitting.
`destinationMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a destination location marker. Invoked whenever a new destination marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`locationProvider optional`	Type: `LocationProvider optional` A source of tracked locations to be shown in the tracking map view. Optional.
`locationProviders optional`	Type: `Array<LocationProvider> optional` Sources of tracked locations to be shown in the tracking map view. Optional.
`mapOptions optional`	Type: `MapOptions optional` Map options passed into the google.maps.Map constructor.
`originMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for an origin location marker. Invoked whenever a new origin marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`pingMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a ping location marker. Invoked whenever a new ping marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`successfulTaskMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a successful task location marker. Invoked whenever a new successful task marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`takenRoutePolylineSetup optional`	Type: `PolylineSetup optional` Configures options for a taken route polyline. Invoked whenever a new taken route polyline is rendered. If specifying a function, the function can and should modify the input's defaultPolylineOptions field containing a google.maps.PolylineOptions object, and return it as polylineOptions in the output PolylineSetupOptions object. Specifying a PolylineSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same PolylineSetupOptions object in different PolylineSetup functions or static values, and do not reuse the same google.maps.PolylineOptions object for the polylineOptions key in different PolylineSetupOptions objects. Any values set for polylineOptions.map or polylineOptions.path will be ignored. Any unset or null value will be overwritten with the default.
`taskOutcomeMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a task outcome location marker. Invoked whenever a new task outcome location marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`unsuccessfulTaskMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for an unsuccessful task location marker. Invoked whenever a new unsuccessful task marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`vehicleMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a vehicle location marker. Invoked whenever a new vehicle marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.
`waypointMarkerSetup optional`	Type: `MarkerSetup optional` Configures options for a waypoint location marker. Invoked whenever a new waypoint marker is rendered. If specifying a function, the function can and should modify the input's defaultMarkerOptions field containing a google.maps.MarkerOptions object, and return it as markerOptions in the output MarkerSetupOptions object. Specifying a MarkerSetupOptions object has the same effect as specifying a function that returns that static object. Do not reuse the same MarkerSetupOptions object in different MarkerSetup functions or static values, and do not reuse the same google.maps.MarkerOptions object for the markerOptions key in different MarkerSetupOptions objects. If markerOptions is unset or null, it will be overwritten with the default. Any value set for markerOptions.map or markerOptions.position will be ignored.

AutomaticViewportMode constants

google.maps.journeySharing.AutomaticViewportMode constants

Automatic viewport mode.

Access by calling const {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing").
See Libraries in the Maps JavaScript API.

Constants
`FIT_ANTICIPATED_ROUTE`	Automatically adjust the viewport to fit markers and any visible anticipated route polylines. This is the default.
`NONE`	Do not automatically adjust the viewport.

LocationProvider abstract class

google.maps.journeySharing.LocationProvider abstract class

Parent class of all location providers.

Methods
`addListener`	`addListener(eventName, handler)` Parameters: `eventName`: `string` The name of the event to listen for. `handler`: `Function` The event handler. Return Value: `MapsEventListener` Adds a `MapsEventListener` for an event fired by this location provider. Returns an identifier for this listener that can be used with `event.removeListener`.

Methods

addListener

addListener(eventName, handler)

Parameters:

eventName: string The name of the event to listen for.
handler: Function The event handler.

Return Value: MapsEventListener

Adds a MapsEventListener for an event fired by this location provider. Returns an identifier for this listener that can be used with event.removeListener.

PollingLocationProvider abstract class

google.maps.journeySharing.PollingLocationProvider abstract class

Parent class of polling location providers.

This abstract class extends LocationProvider.

Properties
`isPolling`	Type: `boolean` True if this location provider is polling. Read only.
`pollingIntervalMillis`	Type: `number` Minimum time between fetching location updates in milliseconds. If it takes longer than `pollingIntervalMillis` to fetch a location update, the next location update is not started until the current one finishes. Setting this value to 0, Infinity, or a negative value disables automatic location updates. A new location update is fetched once if the tracking ID parameter (for example, the shipment tracking ID of the shipment location provider), or a filtering option (for example, viewport bounds or attribute filters for fleet location providers) changes. The default, and minimum, polling interval is 5000 milliseconds. If you set the polling interval to a lower positive value, 5000 is stored and used.

Properties

isPolling

Type: boolean

True if this location provider is polling. Read only.

pollingIntervalMillis

Type: number

Minimum time between fetching location updates in milliseconds. If it takes longer than pollingIntervalMillis to fetch a location update, the next location update is not started until the current one finishes.

Setting this value to 0, Infinity, or a negative value disables automatic location updates. A new location update is fetched once if the tracking ID parameter (for example, the shipment tracking ID of the shipment location provider), or a filtering option (for example, viewport bounds or attribute filters for fleet location providers) changes.

The default, and minimum, polling interval is 5000 milliseconds. If you set the polling interval to a lower positive value, 5000 is stored and used.

Methods
Inherited: `addListener`

Events
`ispollingchange`	`function(event)` Arguments: `event`: `PollingLocationProviderIsPollingChangeEvent` Event that is triggered when the polling state of the location provider is updated. Use `PollingLocationProvider.isPolling` to determine the current polling state.

Events

ispollingchange

function(event)

Arguments:

event: PollingLocationProviderIsPollingChangeEvent

Event that is triggered when the polling state of the location provider is updated. Use PollingLocationProvider.isPolling to determine the current polling state.

PollingLocationProviderIsPollingChangeEvent interface

google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent interface

The event object passed to the event handler when the PollingLocationProvider.ispollingchange event is triggered.

Properties
`error optional`	Type: `Error optional` The error that caused the polling state to change, if the state change was caused by an error. Undefined if the state change was due to normal operations.

Map View

JourneySharingMapView class

Constructor

Properties

Methods

JourneySharingMapViewOptions interface

Properties

AutomaticViewportMode constants

Constants

LocationProvider abstract class

Methods

PollingLocationProvider abstract class

Properties

Methods

Events

PollingLocationProviderIsPollingChangeEvent interface

Properties