Map View

JourneySharingMapView class

google.maps.journeySharing.JourneySharingMapView class

The map view.

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

When using v=beta, can be accessed by calling const {JourneySharingMapView} = await google.map.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.

Properties
`anticipatedRoutePolylines`	Type: `Array<Polyline>` Returns the anticipated route polylines, if any.
`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.
`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.
`locationProvider`	Type: `LocationProvider` This Field is read-only. A source of tracked locations to be shown in the tracking map view.
`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.
`takenRoutePolylines`	Type: `Array<Polyline>` Returns the taken route polylines, if any.
`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.
`destinationMarkerSetup`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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.
`pingMarkerSetup`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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.
`taskOutcomeMarkerSetup`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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.
`destinationMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the destination markers, if any.
`originMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the origin markers, if any.
`successfulTaskMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the successful task markers, if any.
`taskOutcomeMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the task outcome markers, if any.
`unsuccessfulTaskMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the unsuccessful task markers, if any.
`vehicleMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the vehicle markers, if any.
`waypointMarkers`	Deprecated: getting a list of markers via the `MapView` is deprecated. Use the `MarkerCustomizationFunction`s for your location provider to receive callbacks when a marker is added to the map or updated. Type: `Array<Marker>` Returns the waypoint markers, if any.

JourneySharingMapViewOptions interface

google.maps.journeySharing.JourneySharingMapViewOptions interface

Options for the map view.

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

Properties
`element`	Type: `Element` The DOM element backing the view. Required.
`locationProvider`	Type: `LocationProvider` A source of tracked locations to be shown in the tracking map 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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.
`mapOptions optional`	Type: `MapOptions optional` Map options passed into the google.maps.Map constructor.
`originMarkerSetup optional`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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`	Deprecated: Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. This field will be removed in the future. 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.

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

When using v=beta, can be accessed by calling const {AutomaticViewportMode} = await google.map.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.

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

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.

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

Properties
`isPolling`	Type: `boolean` True if this location provider is polling. Read only.

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.

PollingLocationProviderIsPollingChangeEvent interface

google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent interface

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

Load using the &libraries=journeySharing URL parameter. See Libraries in the Maps JavaScript API.

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

JourneySharingMapViewOptions interface

Properties

AutomaticViewportMode constants

Constants

LocationProvider abstract class

Methods

PollingLocationProvider abstract class

Properties

Methods

Events

PollingLocationProviderIsPollingChangeEvent interface

Properties