Interface IRoutePlanService

路线规划服务

Since

1.0.0

interface IRoutePlanService {
    interruptRoutePlan(): void;
    routePlanWithRouteNode(param, routePlanListener): void;
    displayRoutePlanResult(multiRouteDisplayOption?): void;
    naviCalcRoute(routeIndex): Promise<void>;
    naviCalcRouteWithRouteBook(routeData, routeParam?): Promise<void>;
    setRouteSelectCallback(callback): void;
    clearRouteSelectCallback(): void;
    switchRoute(routeIndex): Promise<boolean>;
    cancelRoutePlanDisplay(): void;
}

Hierarchy

ILifecycleInternal
- IRoutePlanService

Index

Methods

interruptRoutePlan routePlanWithRouteNode displayRoutePlanResult naviCalcRoute naviCalcRouteWithRouteBook setRouteSelectCallback clearRouteSelectCallback switchRoute cancelRoutePlanDisplay

Methods

interruptRoutePlan

interruptRoutePlan(): void
中断路线规划

Returns void
Since
1.0.0

routePlanWithRouteNode

routePlanWithRouteNode(param, routePlanListener): void
路线规划
Parameters
- param: RoutePlanOption
- routePlanListener: IRoutePlanListener
  路线规划结果监听
Returns void
Since
1.0.0

displayRoutePlanResult

displayRoutePlanResult(multiRouteDisplayOption?): void
展示多路线接口展示数据基于该路线规划服务最近的一次路线检索结果
Parameters
- Optional multiRouteDisplayOption: MultiRouteDisplayOption
Returns void
Since
1.0.0

naviCalcRoute

naviCalcRoute(routeIndex): Promise<void>
导航算路
Parameters
- routeIndex: number
  选择的路线
Returns Promise<void>
Since
1.0.0

naviCalcRouteWithRouteBook

naviCalcRouteWithRouteBook(routeData, routeParam?): Promise<void>
路书导航算路
Parameters
- routeData: ArrayBuffer
- Optional routeParam: RoutePlanOption
Returns Promise<void>
Since
1.0.0

setRouteSelectCallback

setRouteSelectCallback(callback): void
设置路线选择回调。设置后会回调步骑行服务实例销毁前所有的路线选择
Parameters
- callback: ((routeIndex, routeModel) => void)
  路线选择回调函数，参数为选中的路线索引
  - - (routeIndex, routeModel): void
    - Parameters
      routeIndex: number
      routeModel: WalkPlanModel
      Returns void
Returns void

clearRouteSelectCallback

clearRouteSelectCallback(): void
清除路线选择回调移除已设置的路线选择回调函数

Returns void

switchRoute

switchRoute(routeIndex): Promise<boolean>
切换路线
Parameters
- routeIndex: number
  要切换到的路线索引
Returns Promise<boolean>

cancelRoutePlanDisplay

cancelRoutePlanDisplay(): void
取消显示路线规划结果清除已绘制的路线覆盖层不会影响已配置的绘制参数

Returns void