RoutePlan

此类表示一条驾车、步行或骑行出行方案。它没有构造函数,可通过DrivingRouteResult.getPlan()方法或WalkingRouteResult类的getPlan()方法获得。

构造函数

方法

  • 返回方案总距离。当format参数为true时,返回方案距离字符串(包含单位),当format为false时,仅返回数值(单位为米)信息。默认参数为true

    参数类型说明
    formatboolean

    返回值 string | number

    示例代码1

    const distanceText = routePlan.getDistance(true); // '12.5公里'
    const distanceNum = routePlan.getDistance(false); // 12500
  • 返回方案总时间。当format参数为true时,返回描述时间的字符串(包含单位),当format为false时,仅返回数值(单位为秒)信息。默认参数为true

    参数类型说明
    formatboolean

    返回值 string | number

    示例代码1

    const durationText = routePlan.getDuration(true); // '约25分钟'
    const durationNum = routePlan.getDuration(false); // 1500
  • 返回方案包含的线路的个数

    返回值 number

  • 返回方案中索引指定的线路。索引0表示第一条线路

    参数类型说明
    inumber

    返回值 Route

    示例代码1

    const route = routePlan.getRoute(0);
    console.log(route.getDistance(true)); // '12.5公里'