EBikeRoute

电动车路线规划服务类,用于获取两点间的电动车出行方案。

用法与 RidingRoute 一致,构造参数和检索结果的结构也相同,区别在于: 支持途经点;起终点必须同为关键字或同为坐标/POI,不能混用。

构造函数

  • 创建电动车路线规划实例

    参数类型说明
    locationstring | Point | Map检索区域,可以是地图实例、坐标点或城市名称字符串
    opts 可选RidingRouteOptions可选参数,与 RidingRoute 相同
    属性类型说明
    onInfoHtmlSetFunction标注气泡内容创建后的回调函数
    onMarkersSetFunction标注添加完成后的回调函数,参数为起终点 POI 数组
    onPolylinesSetFunction路线折线添加完成后的回调函数,参数为折线覆盖物数组
    onResultsHtmlSetFunction结果列表创建后的回调函数
    onSearchCompleteFunction检索完成后的回调函数
    renderOptionsRouteRenderOptions结果呈现设置

    返回值 EBikeRoute

    示例代码1

    // 设置 renderOptions.map,路线和标注自动渲染到地图上
    const ebikeRoute = new BMap.EBikeRoute(map, {
    renderOptions: { map: map, autoViewport: true },
    onSearchComplete(results) {
    console.log('路线已自动绘制到地图');
    },
    });
    ebikeRoute.search('北京大学', '清华大学');

    示例代码2

    // 设置展示面板 + viewportOptions.margins 避免面板遮挡路线聚焦区域
    const ebikeRoute = new BMap.EBikeRoute(map, {
    renderOptions: {
    map: map,
    panel: 'route-panel',
    autoViewport: true,
    viewportOptions: { margins: [20, 20, 20, 300] },
    },
    });
    ebikeRoute.search(new BMap.Point(116.391, 39.910), new BMap.Point(116.431, 39.931));

    示例代码3

    // 纯回调用法,不自动渲染到地图
    const ebikeRoute = new BMap.EBikeRoute(map, {
    onSearchComplete(results) {
    if (ebikeRoute.getStatus() === 0) {
    const plan = results.getPlan(0);
    console.log('电动车骑行距离:', plan.getDistance(true));
    }
    },
    });

方法

  • 清除最近一次检索的结果,同时清除地图上的路线和标注

    返回值 void

  • 禁用自动调整地图视野

    返回值 void

  • 启用自动调整地图视野

    返回值 void

  • 发起电动车路线检索。起终点必须同为关键字,或同为坐标点/LocalResultPoi; 混用时不发起检索,状态码置为 BMAP_STATUS_INVALID_REQUEST 并直接触发 onSearchComplete

    参数类型说明
    startstring | Point | LocalResultPoi起点,可以是关键字、坐标点或 LocalResultPoi 实例
    endstring | Point | LocalResultPoi终点,可以是关键字、坐标点或 LocalResultPoi 实例
    options 可选object

    检索参数

    属性类型说明
    waypoints 可选Point途经点坐标数组

    返回值 void

    示例代码1

    ebikeRoute.search('北京大学', '清华大学');
    ebikeRoute.search(
    new BMap.Point(116.391, 39.910),
    new BMap.Point(116.431, 39.931),
    { waypoints: [new BMap.Point(116.411, 39.920)] }
    );
  • 设置气泡打开后的回调函数

    参数类型说明
    callback(poi: LocalResultPoi, html: HTMLElement) => void回调函数

    返回值 void

  • 设置检索区域

    参数类型说明
    locationstring | Point | Map地图实例、坐标点或城市名称字符串

    返回值 void

    示例代码1

    ebikeRoute.setLocation('北京');
    
  • 设置标注添加完成后的回调函数

    参数类型说明
    callback(pois: LocalResultPoi[]) => void回调函数,参数为起终点 POI 数组

    返回值 void

  • 设置路线折线添加完成后的回调函数

    参数类型说明
    callback(polylines: Polyline[]) => void回调函数,参数为折线覆盖物数组

    返回值 void

  • 设置路线折线的样式,配置项会增量合并到 renderOptions.polylineStyle, 并立即刷新已经绘制在地图上的折线,无需重新检索

    参数类型说明
    stylePolylineOptions折线样式配置
    属性类型说明
    clipboolean是否进行跨经度180度裁剪,绘制跨经度180度的折线时可设置为 false 以优化效果
    coordType"BMAP_COORD_BD09" | "BMAP_COORD_GCJ02" | "BMAP_COORD_WGS84"输入坐标的坐标类型。未设置时使用全局 BMap.coordType。
    dashArraynumber[]虚线样式配置,如 [8, 4] 表示实线部分长8像素、间隙部分长4像素。 默认虚线中实线和空隙的长度均为线宽的2倍
    enableClickingboolean是否响应点击事件
    enableEditingboolean是否启用线编辑
    enableMassClearboolean是否在调用 map.clearOverlays() 时清除此覆盖物
    geodesicboolean是否开启大地线模式,为 true 时两点连线将以大地线的形式呈现
    iconsIconSequence[]配置贴合折线的图标
    linkRightboolean跨180度经线时是否按最短路径绘制
    strokeColorstring折线颜色,格式为 '#xxxxxx',默认跟随主题色(CSS 变量 --bmap-color-primary,缺省为 '#1677ff')
    strokeLineCap"round" | "butt" | "square"描边线端头类型
    strokeLineJoin"round" | "miter" | "bevel"描边线连接处类型
    strokeOpacitynumber折线的透明度,取值范围0 - 1,默认值为 1
    strokeStyle"solid" | "dashed" | "dotted"折线的样式
    strokeTexture{ height?: number; url: string; width?: number }线纹理配置,用于沿折线重复绘制图片(如方向箭头),仅 WebGL 渲染模式支持
    strokeWeightnumber折线的宽度,以像素为单位,默认值为 2
    zIndexnumber覆盖物的初始层叠顺序,也可在实例上通过 setZIndex() 方法修改

    返回值 void

    示例代码1

    ebikeRoute.setPolylineStyle({
    strokeColor: '#1677ff',
    strokeWeight: 8,
    highlight: { strokeColor: '#ff4d4f' },
    });
  • 设置结果列表创建后的回调函数

    参数类型说明
    callback(container: HTMLElement) => void回调函数

    返回值 void

  • 设置检索结束后的回调函数

    参数类型说明
    callback(results: RidingRouteResult) => void回调函数

    返回值 void

    示例代码1

    ebikeRoute.setSearchCompleteCallback((results) => {
    console.log('方案数:', results.getNumPlans());
    });