UI Customization

PolylineSetup typedef

google.maps.journeySharing.PolylineSetup typedef

PolylineSetup type.

The type accepts either a PolylineSetupOptions object, or a function that accepts a DefaultPolylineSetupOptions object and returns a PolylineSetupOptions object.

If specifying a function, the function can and should modify the input's defaultPolylineOptions field, and return it as polylineOptions in the output PolylineSetupOptions object.

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

PolylineSetupOptions|(function(DefaultPolylineSetupOptions): PolylineSetupOptions)

PolylineSetupOptions interface

google.maps.journeySharing.PolylineSetupOptions interface

PolylineSetup options.

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

polylineOptions optional
Type:  PolylineOptions optional
Polyline options.
visible optional
Type:  boolean optional
Polyline visibility.

DefaultPolylineSetupOptions interface

google.maps.journeySharing.DefaultPolylineSetupOptions interface

PolylineSetup default options.

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

defaultPolylineOptions
Default polyline options.
defaultVisible
Type:  boolean
Default polyline visibility.

MarkerSetup typedef

google.maps.journeySharing.MarkerSetup typedef

MarkerSetup type.

The type accepts either a MarkerSetupOptions object, or a function that accepts a DefaultMarkerSetupOptions object and returns a MarkerSetupOptions object.

If specifying a function, the function can and should modify the input's defaultMarkerOptions field, and return it as markerOptions in the output MarkerSetupOptions object.

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

MarkerSetupOptions|(function(DefaultMarkerSetupOptions): MarkerSetupOptions)

MarkerSetupOptions interface

google.maps.journeySharing.MarkerSetupOptions interface

MarkerSetup options.

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

markerOptions optional
Type:  MarkerOptions optional
Marker options.

DefaultMarkerSetupOptions interface

google.maps.journeySharing.DefaultMarkerSetupOptions interface

MarkerSetup default options.

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

defaultMarkerOptions
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.

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

defaultOptions
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 by FleetEngineDeliveryVehicleLocationProviderOptions.deliveryVehicleMarkerCustomization and FleetEngineDeliveryFleetLocationProviderOptions.deliveryVehicleMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

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

vehicle
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 by FleetEngineDeliveryVehicleLocationProviderOptions.plannedStopMarkerCustomization.

This interface extends DeliveryVehicleMarkerCustomizationFunctionParams.

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

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 by FleetEngineDeliveryVehicleLocationProviderOptions.taskMarkerCustomization and FleetEngineDeliveryVehicleLocationProviderOptions.taskOutcomeMarkerCustomization.

This interface extends DeliveryVehicleMarkerCustomizationFunctionParams.

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

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 by FleetEngineShipmentLocationProviderOptions.deliveryVehicleMarkerCustomization and FleetEngineShipmentLocationProviderOptions.destinationMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

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

task
Type:  Task
The task associated with this marker.

For information about the delivery vehicle servicing this task, use Task.latestVehicleLocationUpdate and Task.remainingVehicleJourneySegments.
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 by FleetEngineTripLocationProviderOptions.vehicleMarkerCustomization, FleetEngineTripLocationProviderOptions.originMarkerCustomization, and FleetEngineTripLocationProviderOptions.destinationMarkerCustomization.

This interface extends MarkerCustomizationFunctionParams.

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

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 by FleetEngineTripLocationProviderOptions.waypointMarkerCustomization.

This interface extends TripMarkerCustomizationFunctionParams.

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

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