您当前的位置: 首页 > JavaScript API 触控版 > 类参考

Class:服务类/DrivingRoute
构造函数
构造函数 描述
DrivingRoute(location:Map|Point|KeyPoint|GbPoint|String[, opts:DrivingRouteOptions]) 创建一个驾车导航实例,其中location表示检索区域,类型可为地图实例、坐标点或城市名称。 (当参数为地图实例时,检索位置由当前地图中心点确定,且支持调整地图视野层级;当参数为坐标时,检索位置由该点所在位置确定;当参数为城市名称时,检索会在该城市内进行。)
DrivingRouteOptions
属性 类型 描述
map Map 展现结果的地图实例。当指定此参数后,搜索结果的标注、线路等均会自动添加到此地图上
autoViewport Boolean 检索结束后是否自动调整地图视野(默认开启)
autoDrawStep Boolean 是否开启自动绘制诱导点(默认开启 )。(自 v1.1 新增)
policy enum DrivingPolic 驾车策略
onSearchComplete Function 检索完成后的回调函数。 参数: results: DrivingRouteResult
onMarkersSet Function 标注添加完成后的回调函数。 参数: pois: Array 起点和目的地点数组,通过marker属性可得到其对应的标注
onPolylinesSet Function 折线添加完成后的回调函数。 参数: routes: Array 驾车线路数组,通过Route.getPolyline()方法可得到对应的折线
onResultsHtmlSet Function 结果列表添加完成后的回调函数。 参数: container: 结果列表所用的HTML元素
panel String 结果列表展示面板容器ID
方法
方法 返回值 描述
search(start:String|Point|KeyPoint|GbPoint, end:String|Point|KeyPoint|GbPoint [,options: SearchOptions]) none 驾车检索。 (start:起点,参数可以是关键字、坐标点。 end:终点,参数可以是关键字、坐标点。 options:可选对象参数。)
getETA(param:Array, callback:Function) none 返回驾车线路的里程和时长估算值。 (自 v1.1 新增)
param: 驾车线路检索参数,为数组,即可同时计算多条驾车线路。数组成员为JSON 对象: {start:Point|KeyPoint|GbPoint,end:Point|KeyPoint|GbPoint[,options: SearchOptions]} ( start 为出发地; end 为目的地;options 为可选参数,可选择传参经由地、回避地...)

callback:执行查询后,数据返回的回调函数,数据以回调函数的参数形式返回。如果查询成功,则回调函数的参数为数组Object 对象:[{distance:"行程总距离,单位:米", time:"行程总时间,单位:秒"}] ,否则回调函数的参数为null
getResults() DrivingRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级,当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用自动调整地图层级
setLocation(location: Map|Point|KeyPoint|GbPoint|String) none 设置检索范围,参数类型可以为地图实例、坐标点或城市名称。例:setLocation("北京市")
setPolicy(policy:DrivingPolicy) none 设置驾车规划策略,参数为策略常量
setSearchCompleteCallback(callback:Function) none 设置检索结束后的回调函数。 参数: results: DrivingRouteResult
setMarkersSetCallback(callback:Function) none 设置添加标注后的回调函数。 参数: pois: Array 起点和目的地点数组,通过marker属性可得到其对应的标注
setPolylinesSetCallback(callback:Function) none 设置绘制路线后的回调函数。 参数: routes: Array 驾车线路数组,通过Route.getPolyline()方法可得到对应的折线
setResultsHtmlSetCallback(callback:Function) none 设置结果列表添加完成后的回调函数。 参数: container: 结果列表所用的HTML元素
getStatus() Object 返回检索结果状态。返回对象包含如下属性: errcode:Number,errmsg:String
SearchOptions
属性 类型 描述
startCity String 驾车查询的起点城市名称
endCity String 驾车查询的终点城市名称
via Array 驾车查询的途经点
startName String 起点自定义名称
endName String 终点自定义名称
vd Array 驾车查询的回避地
fd Array 驾车查询的回避条件(1 表示回避高速,2 表示回避轮渡,4 表示回避收费站,8 表示回避掉头,16 表示回避高架,32 表示回避禁行) (自 v1.1 变更)
ad Array 驾车查询的避免条件(1 表示避免收费,2 表示避免渡轮,4 表示避免收费站,8 表示避免掉头,16 表示避免拥堵) (自 v1.1 变更)
frd Number 驾车查询的渡轮绕行距离(单位:米)
DrivingPolicy
常量 描述
CLDMAP_DRIVING_POLICY_SYSTEM_DEFAULT 系统推荐
CLDMAP_DRIVING_POLICY_PRIORITY_HIGHWAYS 高速优先
CLDMAP_DRIVING_POLICY_LEAST_DISTANCE 最短距离
CLDMAP_DRIVING_POLICY_LEAST_CHARGES 最少收费
CLDMAP_DRIVING_POLICY_WALKING 步行