CRC-BMAP

Appearance

NavPath ​

说明 ​

NavPath 是一个地图插件，用于规划导航路径。

构造函数 ​

typescript
new NavPath();

参数 ​

无

返回值 ​

NavPath 插件实例

属性 ​

initRoadStatus ​

  • 类型：boolean
  • 默认值：false

路网数据初始化状态

方法 ​

loaded ​

typescript
loaded(): Promise<boolean>;

等待道路数据初始化完成

参数 ​

无

返回值 ​

返回 Promise，在道路数据初始化完成后，resolve 为 true

使用示例 ​

typescript
await navPath.loaded();

setRoadData ​

typescript
setRoadData(roadData: RoadData2[], facilities: Facility[]): Promise<void>;

设置道路数据

参数 ​

参数类型说明默认值
roadDataRoadData2[]道路数据-
facilitiesFacility[]设施数据-

返回值 ​

返回 Promise，在道路数据设置完成后，resolve

使用示例 ​

typescript
const roadData = await aibeeLoader.getRoadNetworkData()
const facilities = await aibeeLoader.getFacilitiesData()
navPath.setRoadData(roadData, facilities.infrastructures)

getPath ​

typescript
getPath(start: Start2, end: End2, type?: RouteType2, permission?: number, travelDirection?: number, options?: GetPathOtherParams): Promise<PathData2>;

获取导航路径

参数 ​

参数类型说明默认值
start{
floor: string;
nodeId?: string;
coord?: [number, number];
}		路线的起点
  • floor 楼层
  • nodeId 图元id
  • coord 地图坐标

    • nodeId 和 coord 必须有一个    		-
    end{
    nodeId?: string;
    coord?: [number, number];
    floor?: string;
    facility?: string;
    parkingSpace?: string;
    }    		路线的终点
  • nodeId 图元ID
  • coord 地图坐标
  • floor 终点楼层
  • facility 设施类型id
  • parkingSpace 车位号

    • 当目的地是 facility 时，floor 不是必传的，其他类型终点，必须有 floor 参数    		-
    type"" | "escalator" | "straightLadder" | "forward"路线类型
  • "" 最短路径
  • escalator 扶梯优先
  • straightLadder 直梯优先
  • forward 车型路线
    		• ""
    permissionnumber路网权限，默认走无权限路线，传1 走通行卡权限路线-
    travelDirectionnumber路线前进方向，指南针角度，type 是 forward 时，使用这个参数-

    返回值 ​

    返回 Promise，在路径计算完成后，resolve 为路径数据
    Promise cache 表示规划路线失败，并给出失败的原因

    使用示例 ​

    typescript
    const pathData = await navPath.getPath(start, end);

    getDirectionPath ​

    typescript
    getDirectionPath(points: [number, number][]): Promise<DirectionPathData[]>;

    获取方向路径（路书）

    参数 ​

    参数类型说明默认值
    points[number, number][]路径点集合-

    返回值 ​

    返回 Promise，在路径计算完成后，resolve 为方向路径数据

    使用示例 ​

    typescript
    const directionPath = await navPath.getDirectionPath(points);

    dispose ​

    typescript
    dispose(): void;

    销毁导航路径插件实例

    WARNING

    插件不依赖 bmap，需要手动销毁

    参数 ​

    无

    返回值 ​

    无

    使用示例 ​

    typescript
    navPath.dispose();

    事件 ​

    init-road-status ​

    typescript
    (event: "init-road-status", args: { status: boolean }): void;

    道路数据初始化状态变更事件

    参数 ​

    参数类型说明默认值
    statusboolean初始化状态-

    返回值 ​

    无

    使用示例 ​

    typescript
    navPath.addEventListener("init-road-status", ({ status }) => {
  console.log("road data init status:", status);
});