Class MPRouteLeg

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

MPRouteLeg

Index

Properties

distance? duration? endAdress? endLocation? legEndReason? legStartReason? startAddress? startLocation? steps? stopIndex?

Methods

toJSON create

Properties

`Optional` `Readonly`distance

distance?: MPRouteProperty

The distance of the leg.

`Optional` `Readonly`duration

duration?: MPRouteProperty

The expected time it takes to traverse the leg.

`Optional` `Readonly`endAdress

endAdress?: string

The address at the end of the leg.

`Optional` `Readonly`endLocation

endLocation?: MPRouteCoordinate

The end coordinate of the leg.

`Optional` `Readonly`legEndReason

legEndReason?: string

The reason for the end of the leg.

`Optional` `Readonly`legStartReason

legStartReason?: string

The reason for the start of the leg.

`Optional` `Readonly`startAddress

startAddress?: string

The address at the start of the leg.

`Optional` `Readonly`startLocation

startLocation?: MPRouteCoordinate

The start coordinate of the leg.

`Optional` `Readonly`steps

steps?: MPRouteStep[]

The steps the leg consists of.

`Optional` `Readonly`stopIndex

stopIndex?: number

The index of the stop.

Methods

toJSON

toJSON(): MPRouteLegParams
Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

Returns MPRouteLegParams
- Defined in MPRouteLeg.ts:74

`Static`create

create(object: MPRouteLegParams): MPRouteLeg
Creator for MPRouteLeg, used to decode JSON from the MapsIndoors SDK.
Parameters
- object: MPRouteLegParams
Returns MPRouteLeg
Static
- Defined in MPRouteLeg.ts:52

Class MPRouteLeg

Export

Index

Properties

Methods

Properties

`Optional` `Readonly`distance

`Optional` `Readonly`duration

`Optional` `Readonly`endAdress

`Optional` `Readonly`endLocation

`Optional` `Readonly`legEndReason

`Optional` `Readonly`legStartReason

`Optional` `Readonly`startAddress

`Optional` `Readonly`startLocation

`Optional` `Readonly`steps

`Optional` `Readonly`stopIndex

Methods

toJSON

Returns MPRouteLegParams

`Static`create

Parameters

Returns MPRouteLeg

Static

Settings

On This Page

Class MPRouteLeg

Export

Index

Properties

Methods

Properties

Optional Readonlydistance

Optional Readonlyduration

Optional ReadonlyendAdress

Optional ReadonlyendLocation

Optional ReadonlylegEndReason

Optional ReadonlylegStartReason

Optional ReadonlystartAddress

Optional ReadonlystartLocation

Optional Readonlysteps

Optional ReadonlystopIndex

Methods

toJSON

Returns MPRouteLegParams

Staticcreate

Parameters

Returns MPRouteLeg

Static

Settings

On This Page

`Optional` `Readonly`distance

`Optional` `Readonly`duration

`Optional` `Readonly`endAdress

`Optional` `Readonly`endLocation

`Optional` `Readonly`legEndReason

`Optional` `Readonly`legStartReason

`Optional` `Readonly`startAddress

`Optional` `Readonly`startLocation

`Optional` `Readonly`steps

`Optional` `Readonly`stopIndex

`Static`create