Class MPRoute

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

Export

MPRoute

Index

Properties

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

Methods

create

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`ordered_stop_indexes

ordered_stop_indexes?: number[]

`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: MPRouteParams): MPRoute
Creator for MPRoute, used to decode JSON from the MapsIndoors SDK.
Parameters
- object: MPRouteParams
Returns MPRoute
Static
- Defined in MPRoute.ts:41

Class MPRoute

Export

Index

Properties

Methods

Properties

`Optional` `Readonly`bounds

`Optional` `Readonly`copyrights

`Optional` `Readonly`legs

`Optional` `Readonly`ordered_stop_indexes

`Optional` `Readonly`restrictions

`Optional` `Readonly`summary

`Optional` `Readonly`warnings

Methods

`Static`create

Parameters

Returns MPRoute

Static

Settings

On This Page

Class MPRoute

Export

Index

Properties

Methods

Properties

Optional Readonlybounds

Optional Readonlycopyrights

Optional Readonlylegs

Optional Readonlyordered_stop_indexes

Optional Readonlyrestrictions

Optional Readonlysummary

Optional Readonlywarnings

Methods

Staticcreate

Parameters

Returns MPRoute

Static

Settings

On This Page

`Optional` `Readonly`bounds

`Optional` `Readonly`copyrights

`Optional` `Readonly`legs

`Optional` `Readonly`ordered_stop_indexes

`Optional` `Readonly`restrictions

`Optional` `Readonly`summary

`Optional` `Readonly`warnings

`Static`create