Introducing Places UI Kit: A ready-to-use, low-cost component library that lets you bring the familiar Google Maps UI for Places to any map of your choice. Try it out, andshare your input to help shape the future of GMP!

Map View

JourneySharingMapViewclass

google.maps.journeySharing.JourneySharingMapViewclass

The map view.

Access by callingconst {JourneySharingMapView} = await google.maps.importLibrary("journeySharing").
SeeLibraries in the Maps JavaScript API.

Constructor

JourneySharingMapView
JourneySharingMapView(options)
Parameters: 
Instantiates a map view.

Properties

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 theJourneySharingMapView.addLocationProvider andJourneySharingMapView.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

Deprecated: UseJourneySharingMapView.locationProviders instead.

Type: LocationProvideroptional
This Field is read-only. A source of tracked locations to be shown in the tracking map view.
destinationMarkerSetup

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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 theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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 theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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 theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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 theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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

Deprecated: Polyline setup is deprecated. Use thePolylineCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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

Deprecated: Polyline setup is deprecated. Use thePolylineCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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 theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

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

Deprecated: getting a list of markers via theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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 theMapView is deprecated. Use theMarkerCustomizationFunctions 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.
anticipatedRoutePolylines

Deprecated: getting a list of polylines via theMapView is deprecated. Use thePolylineCustomizationFunctions for your location provider to receive callbacks when a polyline is added to the map or updated.

Type: Array<Polyline>
Returns the anticipated route polylines, if any.
takenRoutePolylines

Deprecated: getting a list of polylines via theMapView is deprecated. Use thePolylineCustomizationFunctions for your location provider to receive callbacks when a polyline is added to the map or updated.

Type: Array<Polyline>
Returns the taken route polylines, if any.

Methods

addLocationProvider
addLocationProvider(locationProvider)
Parameters: 
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: 
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.

JourneySharingMapViewOptionsinterface

google.maps.journeySharing.JourneySharingMapViewOptionsinterface

Options for the map view.

Properties

element
Type: Element
The DOM element backing the view. Required.
anticipatedRoutePolylineSetupoptional

Deprecated: Polyline setup is deprecated. Use thePolylineCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: PolylineSetupoptional
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.
automaticViewportModeoptional
Type: AutomaticViewportModeoptional
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.
destinationMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
locationProvideroptional

Deprecated: UseJourneySharingMapViewOptions.locationProviders instead.

Type: LocationProvideroptional
A source of tracked locations to be shown in the tracking map view. Optional.
locationProvidersoptional
Type: Array<LocationProvider>optional
Sources of tracked locations to be shown in the tracking map view. Optional.
mapOptionsoptional
Type: MapOptionsoptional
Map options passed into the google.maps.Map constructor.
originMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
pingMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
successfulTaskMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
takenRoutePolylineSetupoptional

Deprecated: Polyline setup is deprecated. Use thePolylineCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: PolylineSetupoptional
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.
taskOutcomeMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
unsuccessfulTaskMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
vehicleMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.
waypointMarkerSetupoptional

Deprecated: Marker setup is deprecated. Use theMarkerCustomizationFunction methods for your location provider instead. This field will be removed in the future.

Type: MarkerSetupoptional
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.

AutomaticViewportModeconstants

google.maps.journeySharing.AutomaticViewportModeconstants

Automatic viewport mode.

Access by callingconst {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing").
SeeLibraries in the Maps JavaScript API.

Constants

FIT_ANTICIPATED_ROUTEAutomatically adjust the viewport to fit markers and any visible anticipated route polylines. This is the default.
NONEDo not automatically adjust the viewport.

LocationProviderabstract class

google.maps.journeySharing.LocationProviderabstract 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 aMapsEventListener for an event fired by this location provider. Returns an identifier for this listener that can be used withevent.removeListener.

PollingLocationProviderabstract class

google.maps.journeySharing.PollingLocationProviderabstract class

Parent class of polling location providers.

This abstract class extendsLocationProvider.

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 thanpollingIntervalMillis 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)
Event that is triggered when the polling state of the location provider is updated. UsePollingLocationProvider.isPolling to determine the current polling state.

PollingLocationProviderIsPollingChangeEventinterface

google.maps.journeySharing.PollingLocationProviderIsPollingChangeEventinterface

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

Properties

erroroptional
Type: Erroroptional
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.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-18 UTC.