Class MPRoute

A route from a origin to a destination broken up into legs.

Export

Hierarchy

MPRoute

Index

Constructors

Properties

bounds? copyrights? legs? restrictions? summary? warnings?

Methods

Constructors

`Private` constructor

new MPRoute(legs?, copyrights?, summary?, warnings?, restrictions?, bounds?): MPRoute
Private
Creates an instance of MPRoute.
Parameters
- Optional legs: MPRouteLeg[]
  
  The legs the route consists of.
- Optional copyrights: string
  
  The copyrights for this route, if any exists.
- Optional summary: string
  
  A summary of the route.
- Optional warnings: string[]
  
  Any warnings issued for any paths on the route.
- Optional restrictions: string[]
  
  All restrictions in place for the route.
- Optional bounds: MPBounds
  
  The outer bounds of the route.
Returns MPRoute
- Defined in src/core/MPRoute.ts:23

Properties

`Optional` `Readonly` bounds

bounds?: MPBounds

The outer bounds of the route.

`Optional` `Readonly` copyrights

copyrights?: string

The copyrights for this route, if any exists.

`Optional` `Readonly` legs

legs?: MPRouteLeg[]

The legs the route consists of.

`Optional` `Readonly` restrictions

restrictions?: string[]

All restrictions in place for the route.

`Optional` `Readonly` summary

summary?: string

A summary of the route.

`Optional` `Readonly` warnings

warnings?: string[]

Any warnings issued for any paths on the route.

Methods

`Static` create

create(object): MPRoute
Creator for MPRoute, used to decode JSON from the MapsIndoors SDK.
Parameters
- object: MPRouteParams
Returns MPRoute

Static
- Defined in src/core/MPRoute.ts:39

Generated using TypeDoc