A leg of a MPRoute is defined as all steps between any context shifts (entering/exiting buildings, changing floors).

A leg is comprised of a list of steps as well as a startLocation and an endLocation.

Export

Hierarchy

  • MPRouteLeg

Constructors

  • Private

    Creates an instance of MPRouteLeg.

    Parameters

    • Optional steps: MPRouteStep[]

      The steps the leg consists of.

    • Optional distance: MPRouteProperty

      The distance of the leg.

    • Optional duration: MPRouteProperty

      The expected time it takes to traverse the leg.

    • Optional startAddress: string

      The address at the start of the leg.

    • Optional endAdress: string

      The address at the end of the leg.

    • Optional startLocation: MPRouteCoordinate

      The start coordinate of the leg.

    • Optional endLocation: MPRouteCoordinate

      The end coordinate of the leg.

    • Optional legStartReason: string

      The reason for the start of the leg.

    • Optional legEndReason: string

      The reason for the end of the leg.

    • Optional stopIndex: number

      The index of the stop.

    Returns MPRouteLeg

Properties

distance?: MPRouteProperty

The distance of the leg.

duration?: MPRouteProperty

The expected time it takes to traverse the leg.

endAdress?: string

The address at the end of the leg.

endLocation?: MPRouteCoordinate

The end coordinate of the leg.

legEndReason?: string

The reason for the end of the leg.

legStartReason?: string

The reason for the start of the leg.

startAddress?: string

The address at the start of the leg.

startLocation?: MPRouteCoordinate

The start coordinate of the leg.

steps?: MPRouteStep[]

The steps the leg consists of.

stopIndex?: number

The index of the stop.

Methods

  • Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

    Returns MPRouteLegParams

  • Creator for MPRouteLeg, used to decode JSON from the MapsIndoors SDK.

    Parameters

    Returns MPRouteLeg

    Static

Generated using TypeDoc