Class DriveRouteQuery

此类定义了驾车路径查询规划。

Since

1.0.0

Constructors

constructor

new DriveRouteQuery(fromAndTo, mode, passedByPoints, avoidpolygons, avoidRoad): DriveRouteQuery
DriveRouteQuery构造函数。
Parameters
- fromAndTo: FromAndTo
  路径的起点终点。
- mode: number
  计算路径的模式。可选，默认为速度优先 RouteSearch#DrivingDefault。
- passedByPoints: undefined | ArrayList<LatLonPoint>
  途经点，可选。最多支持16个途经点。
- avoidpolygons: undefined | ArrayList<ArrayList<LatLonPoint>>
  避让区域，可选。区域避让，支持32个避让区域，每个区域最多可有16个顶点。如果是四边形则有4个坐标点，如果是五边形则有5个坐标点。同时传入避让区域及避让道路，仅支持避让道路。
- avoidRoad: string
  避让道路名称，可选。目前只支持一条避让道路。
Returns DriveRouteQuery
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:49

Properties

`Private` carType

carType: number = 0

车辆类型, 默认为普通汽车

`Private` exclude

exclude: undefined | string = undefined

规避道路类型，可选值：toll-收费道路；motorway-高速路；ferry-渡船默认无

`Private` mAvoidRoad

mAvoidRoad: string

`Private` `Optional` mAvoidpolygons

mAvoidpolygons?: ArrayList<ArrayList<LatLonPoint>>

`Private` mExtensions

mExtensions: string = "base"

扩展字段 base表示只返回基础数据，all表示所有数据，默认 base

`Private` mFromAndTo

mFromAndTo: FromAndTo

`Private` mMode

mMode: number = 0

`Private` `Optional` mPassedByPoints

mPassedByPoints?: ArrayList<LatLonPoint>

`Private` useFerry

useFerry: boolean = true

轮渡

Methods

getAvoidRoad

getAvoidRoad(): string
返回设定查询的避让道路。

Returns string
设定查询的避让道路。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:125

getAvoidpolygons

getAvoidpolygons(): undefined | ArrayList<ArrayList<LatLonPoint>>
返回设定查询的避让区域。

Returns undefined | ArrayList<ArrayList<LatLonPoint>>
设定查询的避让区域。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:115

getAvoidpolygonsStr

getAvoidpolygonsStr(): undefined | string
将避让区域转换为字符串输出。

Returns undefined | string
避让区域坐标的字符串。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:162

getCarType

getCarType(): number
返回车辆类型。

Returns number
车辆类型。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:84

getExclude

getExclude(): undefined | string
海外生效规避道路类型，可选值：toll-收费道路；motorway-高速路；ferry-渡船，默认不规避

Returns undefined | string
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:198

getExtensions

getExtensions(): string
扩展字段 base表示只返回基础数据，all表示所有数据，默认 base

Returns string
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:219

getFromAndTo

getFromAndTo(): FromAndTo
返回查询路径的起终点。

Returns FromAndTo
查询路径的起终点。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:64

getMode

getMode(): number
返回计算路径的模式。

Returns number
计算路径的模式。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:74

getPassedByPoints

getPassedByPoints(): undefined | ArrayList<LatLonPoint>
返回设定查询的途经点。

Returns undefined | ArrayList<LatLonPoint>
设定查询的途经点。

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:105

getPassedPointStr

getPassedPointStr(): undefined | string
将途径点位置坐标转换为字符串输出。

Returns undefined | string
this.途径点坐标的字符串

Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:135

isUseFerry

isUseFerry(): boolean
是否使用轮渡，默认使用

Returns boolean
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:255

setCarType

setCarType(carType): void
设置车辆类型，默认为普通汽车
Parameters
- carType: number
  车辆类型,支持0：普通汽车，1：纯电动车，2：插电混动车
Returns void
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:275

setExclude

setExclude(exclude): void
海外生效规避道路类型，默认不规避可选值： #DRIVING_EXCLUDE_TOLL toll-收费道路；
#DRIVING_EXCLUDE_MOTORWAY motorway-高速路；
#DRIVING_EXCLUDE_FERRY ferry-渡船;
Parameters
- exclude: undefined | string
Returns void
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:211

setExtensions

setExtensions(extensions): void
扩展字段 base表示只返回基础数据，all表示所有数据，默认 base
Parameters
- extensions: string
Returns void
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:227

setUseFerry

setUseFerry(useFerry): void
是否使用轮渡，默认使用
Parameters
- useFerry: boolean
  使用轮渡，true
Returns void
Since
1.0.0
- Defined in module/src/route/DriveRouteQuery.ts:265

Generated using TypeDoc