Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for delivery fleet location provider.

Hierarchy

  • FleetEngineDeliveryFleetLocationProviderOptions

Index

Properties

deliveryVehicleFilter: null | string

A filter query to apply when fetching delivery vehicles. This filter is passed directly to Fleet Engine.

See ListDeliveryVehiclesRequest.filter for supported formats.

Note that valid filters for attributes must have the "attributes" prefix. For example, attributes.x = "y" or attributes."x y" = "z".

deliveryVehicleMarkerCustomization?: null | ((a: DeliveryVehicleMarkerCustomizationFunctionParams) => void)

Customization applied to a delivery vehicle marker.

Use this field to specify custom styling (such as marker icon) and interactivity (such as click handling).

  • If a google.maps.MarkerOptions object is specified, the changes specified in it are applied to the marker after the marker has been created, overwriting its default options if they exist.
  • If a function is specified, it is invoked once when the marker is created, before it is added to the map view. (On this invocation, the isNew parameter in the function parameters object is set to true.) Additionally, this function is invoked when the location provider receives data from Fleet Engine, regardless of whether the data corresponding to this marker have changed.

    See google.maps.journeySharing.DeliveryVehicleMarkerCustomizationFunctionParams for a list of supplied parameters and their uses.

locationRestriction: null | LatLngBounds | LatLngBoundsLiteral

The latitude/longitude bounds within which to track vehicles immediately after the location provider is instantiated. If not set, the location provider does not start tracking any vehicles; use google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider.locationRestriction to set the bounds and begin tracking. To track all delivery vehicles regardless of location, set bounds equivalent to the entire earth.

projectId: string

The consumer's project ID from Google Cloud Console.

staleLocationThresholdMillis: null | number

Threshold for stale vehicle location. If the last updated location for the vehicle is older this threshold, the vehicle will not be displayed. Defaults to 24 hours in milliseconds. If the threshold is less than zero, or Infinity, the threshold will be ignored and the vehicle location will not be considered stale.

Methods

Generated using TypeDoc