Security notice:We have become aware of a security issue that may be affecting websites using specific third-party libraries (including polyfill.io). This issue can sometimes redirect visitors away from the intended website without website owner knowledge or permission. Many of our JavaScript samples previously included apolyfill.ioscript declaration. We have removed this from our samples. If you have used our JavaScript samples that contain this declaration, we recommend removing the declaration.

UI Customization

PolylineSetup typedef

google.maps.journeySharing.PolylineSetup typedef

PolylineSetup type.

The type accepts either aPolylineSetupOptionsobject, or a function that accepts aDefaultPolylineSetupOptionsobject and returns aPolylineSetupOptionsobject.

If specifying a function, the function can and should modify the input'sdefaultPolylineOptionsfield, and return it aspolylineOptionsin the outputPolylineSetupOptionsobject.

PolylineSetupOptions|(function(DefaultPolylineSetupOptions):PolylineSetupOptions)

PolylineSetupOptions interface

google.maps.journeySharing.PolylineSetupOptions interface

PolylineSetup options.

Properties
`polylineOptionsoptional`	Type:`PolylineOptionsoptional` Polyline options.
`visibleoptional`	Type:`booleanoptional` Polyline visibility.

DefaultPolylineSetupOptions interface

google.maps.journeySharing.DefaultPolylineSetupOptions interface

PolylineSetup default options.

Properties
`defaultPolylineOptions`	Type:`PolylineOptions` Default polyline options.
`defaultVisible`	Type:`boolean` Default polyline visibility.

MarkerSetup typedef

google.maps.journeySharing.MarkerSetup typedef

MarkerSetup type.

The type accepts either aMarkerSetupOptionsobject, or a function that accepts aDefaultMarkerSetupOptionsobject and returns aMarkerSetupOptionsobject.

If specifying a function, the function can and should modify the input'sdefaultMarkerOptionsfield, and return it asmarkerOptionsin the outputMarkerSetupOptionsobject.

MarkerSetupOptions|(function(DefaultMarkerSetupOptions):MarkerSetupOptions)

MarkerSetupOptions interface

google.maps.journeySharing.MarkerSetupOptions interface

MarkerSetup options.

Properties
`markerOptionsoptional`	Type:`MarkerOptionsoptional` Marker options.

DefaultMarkerSetupOptions interface

google.maps.journeySharing.DefaultMarkerSetupOptions interface

MarkerSetup default options.

Properties
`defaultMarkerOptions`	Type:`MarkerOptions` Default marker options.

MarkerCustomizationFunctionParams interface

google.maps.journeySharing.MarkerCustomizationFunctionParams interface

Parameters that are common to all marker customization functions. No object of this class is provided directly to any marker customization function; an object of one of its descendent classes is provided instead.

Properties
`defaultOptions`	Type:`MarkerOptions` The default options used to create this marker.
`isNew`	Type:`boolean` If true, the marker was newly created, and the marker customization function is being called for the first time, before the marker has been added to the map view. False otherwise.
`marker`	Type:`Marker` The marker. Any customizations should be made to this object directly.

DeliveryVehicleMarkerCustomizationFunctionParams interface

google.maps.journeySharing.DeliveryVehicleMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to delivery vehicle markers. Used byFleetEngineDeliveryVehicleLocationProviderOptions.deliveryVehicleMarkerCustomizationandFleetEngineDeliveryFleetLocationProviderOptions.deliveryVehicleMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

Properties
`vehicle`	Type:`DeliveryVehicle` The delivery vehicle represented by this marker.
Inherited: `defaultOptions`, `isNew`, `marker`

PlannedStopMarkerCustomizationFunctionParams interface

google.maps.journeySharing.PlannedStopMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to markers representing planned stops. Used byFleetEngineDeliveryVehicleLocationProviderOptions.plannedStopMarkerCustomization.

This interface extends DeliveryVehicleMarkerCustomizationFunctionParams.

Properties
`stopIndex`	Type:`number` The 0-based index of this stop in the list of remaining stops.
Inherited: `defaultOptions`, `isNew`, `marker`, `vehicle`

TaskMarkerCustomizationFunctionParams interface

google.maps.journeySharing.TaskMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to markers representing planned or actual task locations. Used byFleetEngineDeliveryVehicleLocationProviderOptions.taskMarkerCustomizationandFleetEngineDeliveryVehicleLocationProviderOptions.taskOutcomeMarkerCustomization.

This interface extends DeliveryVehicleMarkerCustomizationFunctionParams.

Properties
`task`	Type:`Task` The task location represented by this marker.
Inherited: `defaultOptions`, `isNew`, `marker`, `vehicle`

ShipmentMarkerCustomizationFunctionParams interface

google.maps.journeySharing.ShipmentMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to markers representing shipment delivery vehicle and destination locations. Used byFleetEngineShipmentLocationProviderOptions.deliveryVehicleMarkerCustomizationandFleetEngineShipmentLocationProviderOptions.destinationMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

Properties
`taskTrackingInfo`	Type:`TaskTrackingInfo` Information for the task associated with this marker.
Inherited: `defaultOptions`, `isNew`, `marker`

TripMarkerCustomizationFunctionParams interface

google.maps.journeySharing.TripMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to markers representing trip vehicle, origin and destination locations. Used byFleetEngineTripLocationProviderOptions.vehicleMarkerCustomization,FleetEngineTripLocationProviderOptions.originMarkerCustomization,andFleetEngineTripLocationProviderOptions.destinationMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

Properties
`trip`	Type:`Trip` The trip associated with this marker. For information about the vehicle servicing this trip, use`Trip.latestVehicleLocationUpdate`and`Trip.remainingWaypoints`.
Inherited: `defaultOptions`, `isNew`, `marker`

TripWaypointMarkerCustomizationFunctionParams interface

google.maps.journeySharing.TripWaypointMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to markers representing trip waypoint locations. Used byFleetEngineTripLocationProviderOptions.waypointMarkerCustomization.

This interface extends TripMarkerCustomizationFunctionParams.

Properties
`waypointIndex`	Type:`number` The 0-based waypoint index associated with this marker. Use this index on`Trip.remainingWaypoints`to retrieve information about the waypoint.
Inherited: `defaultOptions`, `isNew`, `marker`, `trip`

VehicleMarkerCustomizationFunctionParams interface

google.maps.journeySharing.VehicleMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to vehicle markers. Used byFleetEngineVehicleLocationProviderOptions.vehicleMarkerCustomizationandFleetEngineFleetLocationProviderOptions.vehicleMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

Properties
`vehicle`	Type:`Vehicle` The vehicle represented by this marker.
Inherited: `defaultOptions`, `isNew`, `marker`

VehicleWaypointMarkerCustomizationFunctionParams interface

google.maps.journeySharing.VehicleWaypointMarkerCustomizationFunctionParams interface

Parameters specific to marker customization functions that apply options to vehicle waypoint markers. Used byFleetEngineVehicleLocationProviderOptions.originMarkerCustomization,FleetEngineVehicleLocationProviderOptions.destinationMarkerCustomizationandFleetEngineVehicleLocationProviderOptions.intermediateDestinationMarkerCustomization

This interface extends VehicleMarkerCustomizationFunctionParams.

Properties
`waypointIndex`	Type:`number` The 0-based waypoint index associated with this marker. Use this index on`Vehicle.waypoints`to retrieve information about the waypoint.
Inherited: `defaultOptions`, `isNew`, `marker`, `vehicle`

PolylineCustomizationFunctionParams interface

google.maps.journeySharing.PolylineCustomizationFunctionParams interface

Parameters that are common to all polyline customization functions. No object of this class is provided directly to any polyline customization function; an object of one of its descendent classes is provided instead.

Properties
`defaultOptions`	Type:`PolylineOptions` The default options used to create this set of polylines.
`isNew`	Type:`boolean` If true, the list of polylines was newly created, and the polyline customization function is being called for the first time. False otherwise.
`polylines`	Type:`Array<Polyline>` The list of polylines created. They are arranged sequentially to form the rendered route.

ShipmentPolylineCustomizationFunctionParams interface

google.maps.journeySharing.ShipmentPolylineCustomizationFunctionParams interface

Parameters specific to polyline customization functions forFleetEngineShipmentLocationProvider.

This interface extends PolylineCustomizationFunctionParams.

Properties
`taskTrackingInfo`	Type:`TaskTrackingInfo` Information for the task associated with this polyline.
Inherited: `defaultOptions`, `isNew`, `polylines`

TripPolylineCustomizationFunctionParams interface

google.maps.journeySharing.TripPolylineCustomizationFunctionParams interface

Parameters specific to polyline customization functions forFleetEngineTripLocationProvider.

This interface extends PolylineCustomizationFunctionParams.

Properties
`trip`	Type:`Trip` The trip associated with this polyline.
Inherited: `defaultOptions`, `isNew`, `polylines`

VehiclePolylineCustomizationFunctionParams interface

google.maps.journeySharing.VehiclePolylineCustomizationFunctionParams interface

Parameters specific to polyline customization functions forFleetEngineVehicleLocationProvider.

This interface extends PolylineCustomizationFunctionParams.

Properties
`vehicle`	Type:`Vehicle` The vehicle traversing through this polyline.
Inherited: `defaultOptions`, `isNew`, `polylines`

DeliveryVehiclePolylineCustomizationFunctionParams interface

google.maps.journeySharing.DeliveryVehiclePolylineCustomizationFunctionParams interface

Parameters specific to polyline customization functions forFleetEngineDeliveryVehicleLocationProvider.

This interface extends PolylineCustomizationFunctionParams.

Properties
`deliveryVehicle`	Type:`DeliveryVehicle` The delivery vehicle traversing through this polyline.
Inherited: `defaultOptions`, `isNew`, `polylines`

UI Customization

PolylineSetup typedef

PolylineSetupOptions interface

Properties

DefaultPolylineSetupOptions interface

Properties

MarkerSetup typedef

MarkerSetupOptions interface

Properties

DefaultMarkerSetupOptions interface

Properties

MarkerCustomizationFunctionParams interface

Properties

DeliveryVehicleMarkerCustomizationFunctionParams interface

Properties

PlannedStopMarkerCustomizationFunctionParams interface

Properties

TaskMarkerCustomizationFunctionParams interface

Properties

ShipmentMarkerCustomizationFunctionParams interface

Properties

TripMarkerCustomizationFunctionParams interface

Properties

TripWaypointMarkerCustomizationFunctionParams interface

Properties

VehicleMarkerCustomizationFunctionParams interface

Properties

VehicleWaypointMarkerCustomizationFunctionParams interface

Properties

PolylineCustomizationFunctionParams interface

Properties

ShipmentPolylineCustomizationFunctionParams interface

Properties

TripPolylineCustomizationFunctionParams interface

Properties

VehiclePolylineCustomizationFunctionParams interface

Properties

DeliveryVehiclePolylineCustomizationFunctionParams interface

Properties