Driving | @types/amap-js-api-driving

Hierarchy

EventEmitter
- Driving

Index

Constructors

constructor

Methods

Constructors

constructor

new Driving(options?: Options): Driving

Overrides EventEmitter.constructor
- Defined in amap-js-api-driving/index.d.ts:329
驾车路线规划服务

Parameters
- Optional options: Options
  
  自定义选项
Returns Driving

Methods

clear

clear(): void

- Defined in amap-js-api-driving/index.d.ts:397
清除搜索结果

Returns void

clearAvoidPolygons

clearAvoidPolygons(): void

- Defined in amap-js-api-driving/index.d.ts:385
清除避让区域

Returns void

clearAvoidRoad

clearAvoidRoad(): void

- Defined in amap-js-api-driving/index.d.ts:381
清除避让道路

Returns void

close

close(): void

- Defined in amap-js-api-driving/index.d.ts:413
Returns void

emit

emit(eventName: string, data?: any): Driving

Inherited from EventEmitter.emit
- Defined in amap-js-api/event.d.ts:34
触发事件

Parameters
- eventName: string
  
  事件名称
- Optional data: any
  
  事件数据
Returns Driving

getAvoidPolygons

getAvoidPolygons(): LngLat[]

- Defined in amap-js-api-driving/index.d.ts:389
获取避让区域

Returns LngLat[]

getAvoidRoad

getAvoidRoad(): string

- Defined in amap-js-api-driving/index.d.ts:393
获取避让道路

Returns string

off

off<C>(eventName: string, handler: "mv" | ((event: any) => void), context?: C): Driving

Inherited from EventEmitter.off
- Defined in amap-js-api/event.d.ts:24
移除事件绑定

Type parameters
- C = Driving
Parameters
- eventName: string
  
  事件名称
- handler: "mv" | ((event: any) => void)
  
  事件功能函数
- Optional context: C
  
  事件上下文
Returns Driving

on

on<C>(eventName: string, handler: (event: any) => void, context?: C, once?: boolean, unshift?: boolean): Driving

Inherited from EventEmitter.on
- Defined in amap-js-api/event.d.ts:11
注册事件

Type parameters
- C = Driving
Parameters
- eventName: string
  
  事件名称
- handler: (event: any) => void
  
  事件回调函数
  - - (event: any): void
    - Parameters
      - event: any
      Returns void
- Optional context: C
  
  事件回调中的上下文
- Optional once: boolean
  
  触发一次
- Optional unshift: boolean
  
  更改事件顺序
Returns Driving

open

open(): void

- Defined in amap-js-api-driving/index.d.ts:412
Returns void

search

search(points: SearchPoint[], callback?: (status: SearchStatus, result: string | SearchResultExt) => void): void
search(origin: LocationValue, destination: LocationValue, callback?: (status: SearchStatus, result: string | SearchResultBase) => void): void
search(origin: LocationValue, destination: LocationValue, opts?: SearchOptions, callback?: (status: SearchStatus, result: string | SearchResultBase) => void): void

- Defined in amap-js-api-driving/index.d.ts:335
以名称关键字查询驾车路线规划

Parameters
- points: SearchPoint[]
  
  途经点数组
- Optional callback: (status: SearchStatus, result: string | SearchResultExt) => void
  
  查询回调
  - - (status: SearchStatus, result: string | SearchResultExt): void
    - Parameters
      - status: SearchStatus
      - result: string | SearchResultExt
      Returns void
Returns void
- Defined in amap-js-api-driving/index.d.ts:345
根据起点、终点坐标查询驾车路线规划

Parameters
- origin: LocationValue
  
  起点坐标
- destination: LocationValue
  
  终点坐标
- Optional callback: (status: SearchStatus, result: string | SearchResultBase) => void
  
  查询回调
  - - (status: SearchStatus, result: string | SearchResultBase): void
    - Parameters
      - status: SearchStatus
      - result: string | SearchResultBase
      Returns void
Returns void
- Defined in amap-js-api-driving/index.d.ts:357
根据起点、终点坐标和途径点查询驾车路线规划

Parameters
- origin: LocationValue
  
  起点坐标
- destination: LocationValue
  
  终点坐标
- Optional opts: SearchOptions
  
  查询选项，用户设定途径点
- Optional callback: (status: SearchStatus, result: string | SearchResultBase) => void
  
  查询回调
  - - (status: SearchStatus, result: string | SearchResultBase): void
    - Parameters
      - status: SearchStatus
      - result: string | SearchResultBase
      Returns void
Returns void

searchOnAMAP

searchOnAMAP(obj: { destination: LocationValue; destinationName?: string; origin: LocationValue; originName?: string }): void

- Defined in amap-js-api-driving/index.d.ts:402
唤起高德地图客户端驾车路径规划

Parameters
- obj: { destination: LocationValue; destinationName?: string; origin: LocationValue; originName?: string }
  
  唤起参数
  - destination: LocationValue
  - Optional destinationName?: string
  - origin: LocationValue
  - Optional originName?: string
Returns void

setAvoidPolygons

setAvoidPolygons(path: LocationValue[][]): void

- Defined in amap-js-api-driving/index.d.ts:372
设置避让区域，最大支持三个避让区域，避让道路和避让区域不能同时使用

Parameters
- path: LocationValue[][]
  
  避让区域
Returns void

setAvoidRoad

setAvoidRoad(road: string): void

- Defined in amap-js-api-driving/index.d.ts:377
设置避让道路名称，只支持一条避让道路，避让道路和避让区域不能同时使用

Parameters
- road: string
  
  道路名称
Returns void

setPolicy

setPolicy(policy?: DrivingPolicy): void

- Defined in amap-js-api-driving/index.d.ts:367
设置驾车路线规划策略

Parameters
- Optional policy: DrivingPolicy
  
  路线规划策略
Returns void

setProvinceAndNumber

setProvinceAndNumber(province: string, number: string): void

- Defined in amap-js-api-driving/index.d.ts:409
设置车牌的汉字首字符和首字后的号码，设置后路线规划的结果将考虑该车牌在当前时间的限行路段

Parameters
- province: string
  
  省份缩写
- number: string
  
  车牌号码
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional options: Options

Returns Driving

Methods

clear

Returns void

clearAvoidPolygons

Returns void

clearAvoidRoad

Returns void

close

Returns void

emit

Parameters

eventName: string

Optional data: any

Returns Driving

getAvoidPolygons

Returns LngLat[]

getAvoidRoad

Returns string

off

Type parameters

C = Driving

Parameters

eventName: string

handler: "mv" | ((event: any) => void)

Optional context: C

Returns Driving

on

Type parameters

C = Driving

Parameters

eventName: string

handler: (event: any) => void

Parameters

event: any

Returns void

Optional context: C

Optional once: boolean

Optional unshift: boolean

Returns Driving

open

Returns void

search

Parameters

points: SearchPoint[]

Optional callback: (status: SearchStatus, result: string | SearchResultExt) => void

Parameters

status: SearchStatus

result: string | SearchResultExt

Returns void

Returns void

Parameters

origin: LocationValue

destination: LocationValue

Optional callback: (status: SearchStatus, result: string | SearchResultBase) => void

Parameters

status: SearchStatus

result: string | SearchResultBase

Returns void

Returns void

Parameters

origin: LocationValue

destination: LocationValue

Optional opts: SearchOptions

Optional callback: (status: SearchStatus, result: string | SearchResultBase) => void

Parameters

status: SearchStatus

result: string | SearchResultBase

Returns void

Returns void

searchOnAMAP

Parameters