UI Customization

PolylineSetup typedef

typedef google.maps.journeySharing.PolylineSetup

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.

PolylineSetupOptions|(function(DefaultPolylineSetupOptions): PolylineSetupOptions)

PolylineSetupOptions interface

interface google.maps.journeySharing.PolylineSetupOptions

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

DefaultPolylineSetupOptions interface

interface google.maps.journeySharing.DefaultPolylineSetupOptions

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

MarkerSetup typedef

typedef google.maps.journeySharing.MarkerSetup

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.

MarkerSetupOptions|(function(DefaultMarkerSetupOptions): MarkerSetupOptions)

MarkerSetupOptions interface

interface google.maps.journeySharing.MarkerSetupOptions

MarkerSetup options.
markerOptions
optional
Type: MarkerOptions optional
Marker options.

DefaultMarkerSetupOptions interface

interface google.maps.journeySharing.DefaultMarkerSetupOptions

MarkerSetup default options.
defaultMarkerOptions
Default marker options.

MarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.MarkerCustomizationFunctionParams

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

interface google.maps.journeySharing.DeliveryVehicleMarkerCustomizationFunctionParams extends MarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to delivery vehicle markers. Used by FleetEngineDeliveryVehicleLocationProviderOptions.deliveryVehicleMarkerCustomization and FleetEngineDeliveryFleetLocationProviderOptions.deliveryVehicleMarkerCustomization.
vehicle
The delivery vehicle represented by this marker.
Inherited: defaultOptions, isNew, marker

PlannedStopMarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.PlannedStopMarkerCustomizationFunctionParams extends DeliveryVehicleMarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to markers representing planned stops. Used by FleetEngineDeliveryVehicleLocationProviderOptions.plannedStopMarkerCustomization.
stopIndex
Type: number
The 0-based index of this stop in the list of remaining stops.
Inherited: defaultOptions, isNew, marker, vehicle

TaskMarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.TaskMarkerCustomizationFunctionParams extends DeliveryVehicleMarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to markers representing planned or actual task locations. Used by FleetEngineDeliveryVehicleLocationProviderOptions.taskMarkerCustomization and FleetEngineDeliveryVehicleLocationProviderOptions.taskOutcomeMarkerCustomization.
task
Type: Task
The task location represented by this marker.
Inherited: defaultOptions, isNew, marker, vehicle

ShipmentMarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.ShipmentMarkerCustomizationFunctionParams extends MarkerCustomizationFunctionParams

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.
taskTrackingInfo
Information for the task associated with this marker.
Inherited: defaultOptions, isNew, marker

TripMarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.TripMarkerCustomizationFunctionParams extends MarkerCustomizationFunctionParams

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

interface google.maps.journeySharing.TripWaypointMarkerCustomizationFunctionParams extends TripMarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to markers representing trip waypoint locations. Used by FleetEngineTripLocationProviderOptions.waypointMarkerCustomization.
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

interface google.maps.journeySharing.VehicleMarkerCustomizationFunctionParams extends MarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to vehicle markers. Used by FleetEngineVehicleLocationProviderOptions.vehicleMarkerCustomization and FleetEngineFleetLocationProviderOptions.vehicleMarkerCustomization.
vehicle
Type: Vehicle
The vehicle represented by this marker.
Inherited: defaultOptions, isNew, marker

VehicleWaypointMarkerCustomizationFunctionParams interface

interface google.maps.journeySharing.VehicleWaypointMarkerCustomizationFunctionParams extends VehicleMarkerCustomizationFunctionParams

Parameters specific to marker customization functions that apply options to vehicle waypoint markers. Used by FleetEngineVehicleLocationProviderOptions.originMarkerCustomization, FleetEngineVehicleLocationProviderOptions.destinationMarkerCustomization and FleetEngineVehicleLocationProviderOptions.intermediateDestinationMarkerCustomization
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

interface google.maps.journeySharing.PolylineCustomizationFunctionParams

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.
defaultOptions
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
The list of polylines created. They are arranged sequentially to form the rendered route.

ShipmentPolylineCustomizationFunctionParams interface

interface google.maps.journeySharing.ShipmentPolylineCustomizationFunctionParams extends PolylineCustomizationFunctionParams

Parameters specific to polyline customization functions for FleetEngineShipmentLocationProvider.
taskTrackingInfo
Information for the task associated with this polyline.
Inherited: defaultOptions, isNew, polylines

TripPolylineCustomizationFunctionParams interface

interface google.maps.journeySharing.TripPolylineCustomizationFunctionParams extends PolylineCustomizationFunctionParams

Parameters specific to polyline customization functions for FleetEngineTripLocationProvider.
trip
Type: Trip
The trip associated with this polyline.
Inherited: defaultOptions, isNew, polylines

VehiclePolylineCustomizationFunctionParams interface

interface google.maps.journeySharing.VehiclePolylineCustomizationFunctionParams extends PolylineCustomizationFunctionParams

Parameters specific to polyline customization functions for FleetEngineVehicleLocationProvider.
vehicle
Type: Vehicle
The vehicle traversing through this polyline.
Inherited: defaultOptions, isNew, polylines

DeliveryVehiclePolylineCustomizationFunctionParams interface

interface google.maps.journeySharing.DeliveryVehiclePolylineCustomizationFunctionParams extends PolylineCustomizationFunctionParams

Parameters specific to polyline customization functions for FleetEngineDeliveryVehicleLocationProvider.
deliveryVehicle
The delivery vehicle traversing through this polyline.
Inherited: defaultOptions, isNew, polylines