TransitRoutePlan

此类表示一条公交出行方案。没有构造函数，通过TransitRouteResult.getPlan()方法获得。

构造函数

#new TransitRoutePlan(): TransitRoutePlan
返回值 TransitRoutePlan

方法

#getDescription(includeHtml: boolean): string
返回方案描述文本，默认包含HTML标签。当includeHtml为false时，方案描述不包含HTML标签

参数类型说明
includeHtml boolean
返回值 string
示例代码1
```
const desc = transitPlan.getDescription(false);
```

#getDistance(format: boolean): string | number
返回方案总距离。当format参数为true时，返回方案距离字符串（包含单位），当format为false时，仅返回数值（单位为米）信息。默认参数为true

参数类型说明
format boolean
返回值 string | number
示例代码1
```
const distance = transitPlan.getDistance(true); // '15.3公里'
```

#getDuration(format: boolean): string | number
返回方案总时间。当format参数为true时，返回描述时间的字符串（包含单位），当format为false时，仅返回数值（单位为秒）信息。默认参数为true

参数类型说明
format boolean
返回值 string | number
示例代码1
```
const duration = transitPlan.getDuration(true); // '约45分钟'
```

#getLine(i: number): Line
返回方案包含的某条公交线路(如果是跨城检索，还包括飞机、火车、大巴线路)

参数类型说明
i number
返回值 Line
示例代码1
```
const line = transitPlan.getLine(0);
```

#getLinesTitle(): string
返回方案中各线路名称的拼接文本，如"线路1 → 线路2"

返回值 string

#getNumLines(): number
返回方案包含的公交线路段数(如果是跨城检索，还包括飞机、火车、大巴线路)

返回值 number

#getNumRoutes(): number
返回方案包含的步行线路段数

返回值 number

#getNumTotal(): number
总路段数量

返回值 number

#getRoute(i: number): Route
返回方案中索引指定的步行线路

参数类型说明
i number
返回值 Route
示例代码1
```
const route = transitRoutePlan.getRoute(0);
console.log(route.getDistance(true));
```

#getTotal(i: number): Line | Route
返回整个方案包含的某段线路，根据方案的数据情况，返回值可能是步行对象Route也有可能是线路对象Line

参数类型说明
i number
返回值 Line | Route
示例代码1
```
const segment = transitPlan.getTotal(0);
```

#getTotalType(i: number): TransitPlanType
返回指定路段的交通方式类型，分别对应Line和Route

参数类型说明
i number
返回值 TransitPlanType
示例代码1
```
const type = transitPlan.getTotalType(0);
```

#getWalkDistance(): number
返回方案总步行距离，单位为米

返回值 number