路径规划最后更新时间: 2023年03月31日

名称	说明	是否插件
AMap.Driving	驾车路线规划服务，提供可带途经点的起点、终点的驾车导航路线查询功能	是
AMap.TruckDriving	货车路线规划服务，提供可带途经点的起点、终点之间的货车导航路线查询功能	是
AMap.Transfer	公交换乘服务，提供起、终点公交路线规划服务，整合步行方式	是
AMap.Walking	步行导航服务，提供起、终点步行路线规划服务	是
AMap.Riding	骑行路径规划服务，提供起、终点骑行路线规划服务	是
AMap.DragRoute	拖拽导航插件	是
AMap.ArrivalRange	公交到达圈展示，提供开发者到达圈类业务的实现思路，根据起点坐标，计算出在指定时间内能够到达的距离范围	是

AMap.Driving

驾车路线规划服务，提供起、终点坐标的驾车导航路线查询功能。AMap. Driving构造函数的参数为 DrivingOptions 对象。DrivingOptions 允许设置驾车策略和返回信息详略。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败，系统将返回错误信息。

相关示例

构造函数	说明
`AMap.Driving(opts:DrivingOptions` `)`	构造函数，创建驾车路线规划实例

DrivingOptions	类型	说明
`policy`	`DrivingPolicy`	驾车路线规划策略
`extensions`	`String`	默认值：base，返回基本地址信息当取值为：all，返回DriveStep基本信息+DriveStep详细信息
`ferry`	`Integer`	默认为0，表示可以使用轮渡，为1的时候表示不可以使用轮渡
`map`	`Map`	AMap.Map对象, 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上。可选
`panel`	`String\|HTMLElement`	结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。可选
`hideMarkers`	`Boolean`	设置隐藏路径规划的起始点图标，设置为true：隐藏图标；设置false：显示图标默认值为：false
`showTraffic`	`Boolean`	设置是否显示实时路况信息，默认设置为true。显示绿色代表畅通，黄色代表轻微拥堵，红色代表比较拥堵，灰色表示无路况信息。
`province`	`String`	车牌省份的汉字缩写，用于判断是否限行，与number属性组合使用，可选。例如：京
`number`	`String`	除省份之外车牌的字母和数字，用于判断限行相关，与province属性组合使用，可选。例如:NH1N11
`isOutline`	`Boolean`	使用map属性时，绘制的规划线路是否显示描边。缺省为true
`outlineColor`	`String`	使用map属性时，绘制的规划线路的描边颜色。缺省为'white'
`autoFitView`	`Boolean`	用于控制在路径规划结束后，是否自动调整地图视野使绘制的路线处于视口的可见范围

方法	返回值	说明
`search(origin:LngLat,destination:LngLat,opts:Object,` `callback:function(status:String,result:info/DrivingResult))` `或 search(points:Array.<Object>,` `callback:function(status:String,result:info/DrivingResult))`		根据起点、终点和途经点（可选）坐标或名称，实现驾车路线规划，途经点通过opts设定，最多支持16个途径点，opts:{waypoints:Array.<LngLat>}； status为complete时，result为DrivingResult；当status为error时，result为错误信息info；当status为no_data时，代表检索返回0结果。注：以名称关键字查询时，points为起点、终点和途经点（可选）名称及对应城市的数组，例如： [{keyword:‘北京南站’,city:‘北京市’}, {keyword:‘广东大厦’,city:’北京市’}, { keyword:‘北京西站’,city:‘北京市’}] 系统取数组第一个元素和最后一个元素作为起点和终点，中间元素为途经点；起终点为经纬度，请使用search(origin:LngLat,destination:LngLat,opts:Object, callback:function(status:String,result:info/DrivingResult)) 起终点为字符串（汉字，比如北京，重庆），请使用search(points:Array.<Object>, callback:function(status:String,result:info/DrivingResult))
`setPolicy(policy:DrivingPolicy)`		设置驾车路线规划策略
`setAvoidPolygons(path:Array.<Array.<LngLat>>)`		设置避让区域，最大支持三个避让区域，参数为LngLat的二维数组
`setAvoidRoad(road:String)`		设置避让道路名称，只支持一条避让道路注：避让道路和避让区域不能同时使用
`clearAvoidRoad()`		清除避让道路
`clearAvoidPolygons()`		清除避让区域
`getAvoidPolygons()`		获取避让区域，返回LngLat的二维数组
`getAvoidRoad()`	`String`	获取避让道路
`clear()`		清除搜索结果
`searchOnAMAP(obj:Object)`		唤起高德地图客户端驾车路径规划 Obj参数形如： { origin:LngLat,//起点坐标 originName: "清华大学",//起点名称 destination:LngLat,//终点坐标 destinationName: "首开广场" //终点名称 }
`setProvinceAndNumber(province:String,number:String)`		设置车牌的汉字首字符和首字后的号码，设置后路线规划的结果将考虑该车牌在当前时间的限行路段

事件	参数	说明
`complete`	`DrivingResult`	当查询成功时触发此事件
`error`	`ErrorStatus`	当查询失败时触发此事件

驾车策略

DrivingPolicy	类型	说明
`AMap.DrivingPolicy.LEAST_TIME`	Const	最快捷模式
`AMap.DrivingPolicy.LEAST_FEE`	Const	最经济模式
`AMap.DrivingPolicy.LEAST_DISTANCE`	Const	最短距离模式
`AMap.DrivingPolicy.REAL_TRAFFIC`	Const	考虑实时路况

AMap.TruckDriving

货车路线规划，自v1.4.4新增，构造函数及方法如下，数据返回结果与Driving一致。

构造函数	说明
`AMap.TruckDriving(opts:TruckDrivingOptions` `)`	构造函数，创建驾车路线规划实例

TruckDrivingOptions	类型	说明
`policy`	`Integer`	路线规划策略，1-9，查看策略详细说明
`size`	`Integer`	车型大小，必填，1-4分别对应小型至大型
`width`	`Number`	宽度，缺省2.5米
`height`	`Number`	高度，缺省1.6米
`load`	`Number`	载重，缺省0.9t
`weight`	`Number`	自重，缺省10t
`axlesNum`	`Integer`	轴数，缺省2轴
`extensions`	`String`	默认值：base，返回基本地址信息当取值为：all，返回DriveStep基本信息+DriveStep详细信息
`map`	`Map`	AMap.Map对象, 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上。可选
`panel`	`String\|HTMLElement`	结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。可选
`hideMarkers`	`Boolean`	设置隐藏路径规划的起始点图标，设置为true：隐藏图标；设置false：显示图标默认值为：false
`showTraffic`	`Boolean`	设置是否显示实时路况信息，默认设置为true。显示绿色代表畅通，黄色代表轻微拥堵，红色代表比较拥堵，灰色表示无路况信息。
`isOutline`	`Boolean`	使用map属性时，绘制的规划线路是否显示描边。缺省为true
`outlineColor`	`String`	使用map属性时，绘制的规划线路的描边颜色。缺省为'white'
`autoFitView`	`Boolean`	用于控制在路径规划结束后，是否自动调整地图视野使绘制的路线处于视口的可见范围
`province`	`String`	车辆牌照省份，如‘京’
`number`	`Number`	车牌号，如‘111111’

方法	返回值	说明
`search(path:Array,` `cbk:function(status:String,result:DrivingResult))`		根据路径，实现货车路线规划，path支持两种格式第一种,使用经纬度： `var path = [];` `path.push({` `lnglat:[116.303843, 39.983412]//位置必填` `pid:'XXXX',//POI ID,可缺省` `type:'YYY'//POI类型，可缺省` `});//起点` `path.push({lnglat:[116.321354, 39.896436]});//途径` `path.push({lnglat:[116.407012, 39.992093]});//终点` `truckdriving.search(path,function(status, result) { });` 第二种，使用关键字自动匹配： `var path = [{keyword:'北京站',city:'010'},//起点` `{keyword:'北京西站',city:'010'},//途径` `{keyword:'北京大学',city:'010'}//终点` `];` `truckdriving.search(path,function(status, result) { });`
`clear()`		清除搜索结果
`setProvinceAndNumber(province:String,number:Number)`		修改车牌号

方法

返回值

说明

search(path:Array,

cbk:function(status:String,result:DrivingResult))

根据路径，实现货车路线规划，path支持两种格式

第一种,使用经纬度：

    var path = [];

    path.push({

      lnglat:[116.303843, 39.983412]//位置必填

      pid:'XXXX',//POI ID,可缺省

      type:'YYY'//POI类型，可缺省

    });//起点

    path.push({lnglat:[116.321354, 39.896436]});//途径

    path.push({lnglat:[116.407012, 39.992093]});//终点

    truckdriving.search(path,function(status, result) {    });

第二种，使用关键字自动匹配：

    var path = [{keyword:'北京站',city:'010'},//起点

            {keyword:'北京西站',city:'010'},//途径

            {keyword:'北京大学',city:'010'}//终点

];

   truckdriving.search(path,function(status, result) {    });

clear()

清除搜索结果

setProvinceAndNumber(province:String,number:Number)

修改车牌号

DrivingResult 对象

属性	类型	说明
`info`	`String`	成功状态说明
`origin`	`LngLat`	驾车规划起点坐标
`destination`	`LngLat`	驾车规划终点坐标
`start`	`Poi`	驾车规划起点
`end`	`Poi`	驾车规划终点
`waypoints`	`Poi`	驾车规划途经点
`taxi_cost`	`Number`	打车费用，仅extensions为“all”时返回单位：元
`routes`	`Array.<DriveRoute>`	驾车规划路线列表

DriveRoute 对象

属性	类型	说明
`distance`	`Number`	起点到终点的驾车距离，单位：米
`time`	`Number`	时间预计，单位：秒
`policy`	`String`	驾车规划策略
`tolls`	`Number`	此驾车路线收费金额，单位：元
`tolls_distance`	`Number`	收费路段长度，单位：米
`steps`	`Array.<DriveStep>`	子路段DriveStep集合
`restriction`	`Number`	限行结果 0 代表限行已规避或未限行，即该路线没有限行路段 1 代表限行无法规避，即该线路有限行路段

DriveStep 对象(基本信息)

属性	类型	说明
`start_location`	`LngLat`	此路段起点
`end_location`	`LngLat`	此路段终点
`instruction`	`String`	此路段说明，如“沿北京南站路行驶565米右转”
`action`	`String`	本驾车子路段完成后动作
`assist_action`	`String`	驾车子路段完成后辅助动作，一般为到达某个目的地时返回
`orientation`	`String`	驾车方向
`road`	`String`	道路
`distance`	`Number`	此路段距离，单位：米
`tolls`	`Number`	此段收费，单位：元
`tolls_distance`	`Number`	收费路段长度，单位：米
`toll_road`	`String`	主要收费道路
`time`	`Number`	此路段预计使用时间，单位：秒
`path`	`Array.<LngLat>`	此路段坐标集合

DriveStep 对象(详细信息）

属性	类型	说明
`cities`	`Array.<ViaCity>`	途径城市列表
`tmcs`	`Array.<TMC>`	实时交通信息列表

ViaCity 对象

属性	类型	说明
`name`	`String`	途径名称
`citycode`	`String`	城市编码
`adcode`	`String`	区域编码
`districts`	`Array.<District>`	途径行政区列表

District 对象

属性	类型	说明
`name`	`String`	区域名称
`adcode`	`String`	区域编码

TMC 对象

属性	类型	说明
`lcode`	`String`	路况信息对应的编码如果direction是正向 lcode返回值大于0；否则lcode，返回值小于0；如果返回0则说明此路段无lcode
`distance`	`Number`	此lcode对应的路段长度，单位: 米
`status`	`String`	路况状态，可能的值有：未知，畅通，缓行，拥堵

属性

类型

说明

lcode

String

路况信息对应的编码

如果direction是正向 lcode返回值大于0；否则lcode，返回值小于0；

如果返回0则说明此路段无lcode

distance

Number

此lcode对应的路段长度，单位: 米

status

String

路况状态，可能的值有：未知，畅通，缓行，拥堵

AMap.Transfer

公交换乘服务，提供起始点公交路线规划服务，目前公交换乘仅支持同一城市的公交路线规划，跨城市出行规划请参考驾车导航查询。公交换乘查询返回结果整合步行信息，若换乘路段（Segment）换乘类型为地铁 “SUBWAY”，则至少包含一条地铁口信息（SubwayEntrance）。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败，系统将返回错误信息。

构造函数	说明
`AMap.Transfer(opts:TransferOptions` `)`	构造函数，提供公交换成查询功能

TransferOptions	类型	说明
`city`	`String`	公交换乘的城市，支持城市名称、城市区号、电话区号，此项为必填
`policy`	`TransferPolicy`	公交换乘策略
`nightflag`	`Boolean`	是否计算夜班车，默认为不计算 true：计算，false：不计算
`cityd`	`String`	终点城市，跨城公交路径规划时为必填参数
`extensions`	`String`	返回结果控制可选值：base/all base:返回基本信息 all:返回全部信息默认值：base
`map`	`Map`	AMap.Map对象, 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上。可选参数
`panel`	`String\|HTMLElement`	结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。可选参数
`hideMarkers`	`Boolean`	设置隐藏路径规划的起始点图标，设置为true：隐藏图标；设置false：显示图标默认值为：false
`isOutline`	`Boolean`	使用map属性时，绘制的规划线路是否显示描边。缺省为true
`outlineColor`	`String`	使用map属性时，绘制的规划线路的描边颜色。缺省为'white'
`autoFitView`	`Boolean`	用于控制在路径规划结束后，是否自动调整地图视野使绘制的路线处于视口的可见范围

方法	返回值	说明
`search(origin:LngLat,destination:LngLat,` `callback:function(status:String,result:info/TransferResult))` `或` `search(point:Array.<Object>,` `callback:function(status:String,result:info/TransferResult))`		根据起点和终点坐标/名称，进行公交换乘查询；当根据起、终点名称查询时，point为包含起点、终点的数组，例： [{keyword:‘北京南站’}, {keyword:‘北京西站’}] 当数组超过两个元素时，取前两个元素为起点、终点，其余元素忽略；当status为complete时，result为TransferResult；当status为error时，result为错误信息info；当status为no_data时，代表检索返回0结果。相关示例
`setPolicy(policy:TransferPolicy)`		设置公交换乘策略
`setCity(city:String)`		设置公交换乘查询的城市
`setCityd(city:String)`		设置公交换乘查询的城市
`leaveAt(time:String,data:String)`		设置公交路径规划出发时间
`clear()`		清除结果显示
`searchOnAMAP(obj:Object)`		唤起高德地图客户端公交路径规划 Obj参数形如： { origin:LngLat,//起点坐标 originName: "清华大学",//起点名称 destination:LngLat,//终点坐标 destinationName: "首开广场" //终点名称 }

事件	参数	说明
`complete`	`TransferResult`	当查询成功时触发此事件
`error`	`ErrorStatus`	当查询失败时触发此事件

TransferPolicy 对象

属性	类型	说明
`LEAST_TIME`	`Const`	最快捷模式
`LEAST_FEE`	`Const`	最经济模式
`LEAST_TRANSFER`	`Const`	最少换乘模式
`LEAST_WALK`	`Const`	最少步行模式
`MOST_COMFORT`	`Const`	最舒适模式
`NO_SUBWAY`	`Const`	不乘地铁模式

TransferResult 对象

属性	类型	说明
`info`	`String`	成功状态说明
`origin`	`LngLat`	公交换乘起点坐标
`destination`	`LngLat`	公交换乘终点坐标
`start`	`Poi`	公交换乘起点
`end`	`Poi`	公交换乘终点
`taxi_cost`	`Number`	出租车费用，单位：元
`plans`	`Array.<TransferPlan>`	换乘方案列表

TransferPlan 对象

属性	类型	说明
`cost`	`Number`	此换乘方案价格，单位：元
`time`	`Number`	预期时间，单位：秒
`distance`	`Number`	此换乘方案全程距离，单位：米
`nightLine`	`Boolean`	是否夜间线路
`walking_distance`	`Number`	此方案总步行距离，单位：米
`transit_distance`	`Number`	此方案公交行驶距离，单位：米
`railway_distance`	`Number`	此方案火车行驶距离，单位：米
`taxi_distance`	`Number`	此方案出租车行驶距离，单位：米
`path`	`Array.<LngLat>`	此换乘方案的路径坐标集合
`segments`	`Array.<Segment>`	换乘路段列表，以每次换乘动结束作为分段点，将整个换乘方案分隔成若干 Segment（换乘路段）

Segment 对象

属性	类型	说明
`instruction`	`String`	此换乘段的文字描述规则：当 transit_mode 为“WALK”时，步行 distance 到 on_station/全程终点；当 transit_mode 为“SUBWAY/BUS/METRO_RAIL”时，乘坐 line ，途径 via_num 站到 off_station/全程终点
`transit_mode`	`String`	换乘动作类型，包括 BUS、SUBWAY、WALK、METRO_RAIL、RAILWAY、TAXI
`time`	`Number`	此换乘段预期用时，单位：秒
`transit`	`TransitDetails\|WalkDetails`	此换乘段导航信息，当 transit_mode 为 “WALK” 时返回 WalkDetails，为 “BUS” 或 “SUBWAY/METRO_RAIL” 时返回 TransitDetails，当transit_mode为“RAILWAY”时，返回RailwayDetails，当transit_mode为“TAXI”时，返回TaxiDetails
`distance`	`Number`	此换乘段距离

WalkDetails 对象

属性	类型	说明
`origin`	`LngLat`	此换乘段的步行起点
`destination`	`LngLat`	此换乘段的步行终点
`steps`	`Array.<WalkStep>`	步行子路段WalkStep列表
`path`	`Array.<LngLat>`	此换乘段坐标集合

WalkStep 对象

属性	类型	说明
`instruction`	`String`	步行子路段描述规则：沿 road步行 distance 米 action，例：”沿北京站街步行351米”
`distance`	`Number`	步行子路段距离，单位：米
`time`	`Number`	步行子路段预计使用时间，单位：秒
`path`	`Array.<LngLat>`	步行子路段坐标集合
`road`	`String`	道路
`action`	`String`	本步行子路段完成后动作
`assist_action`	`String`	步行子路段完成后辅助动作，一般为到达某个公交站点或目的地时返回

TransitDetails 对象

属性	类型	说明
`on_station`	`Stop`	此换乘段的上车站
`off_station`	`Stop`	此换乘段的下车站
`lines`	`Array.<TransitLine>`	此换乘段公交路线
`via_num`	`Number`	途径公交站点数（不包括上车站和下车站）
`via_stops`	`Array.<Stop>`	途径公交站点集合（不包括上车站和下车站）
`path`	`Array.<LngLat>`	此换乘段公交部分（上车站-下车站）坐标集合
`entrance`	`SubwayEntrance`	地铁站入口
`exit`	`SubwayEntrance`	地铁站出口

RailwayDetails 对象

属性	类型	说明
`name`	`String`	线路名称
`id`	`String`	线路id编码
`type`	`String`	线路车次类型，参考火车路线类型列表
`trip`	`Number`	线路车次号
`time`	`Number`	该线路车段耗时
`departure_stop`	`Rail_Stop`	火车始发站信息
`alters`	`Array.<Alter>`	聚合的备选方案，extensions=all时返回
`arrival_stop`	`Rail_Stop`	火车到站信息
`via_stops`	`Array.<Via_Stop>`	途经站点信息，extensions=all时返回
`spaces`	`Array.<Space>`	仓位及价格信息
`distance`	`Number`	该换乘段的行车总距离

TaxiDetails 对象

属性	类型	说明
`origin`	`LngLat`	打车起点坐标
`destination`	`LngLat`	打车终点坐标
`distance`	`Number`	该方案的总距离，单位：米
`time`	`Number`	耗时，单位：秒
`sname`	`String`	起点名称
`tname`	`String`	终点名称

TransitLine 对象

属性	类型	说明
`name`	`String`	公交路线名
`id`	`String`	公交路线ID
`type`	`String`	公交类型，参考公交类型列表
`stime`	`String`	公交路线首班车时间
`etime`	`String`	公交路线末班车时间

SubwayEntrance 对象

属性	类型	说明
`name`	`String`	地铁口名称
`location`	`LngLat`	地铁口经纬度坐标

Stop 对象

属性	类型	说明
`name`	`String`	公交站点名称
`id`	`String`	公交站点ID
`location`	`LngLat`	站点经纬度信息

Via_Stop 对象

属性	类型	说明
`name`	`String`	途径车站点名称
`id`	`String`	途径车站点ID
`location`	`LngLat`	站点经纬度信息
`wait`	`Number`	途径站点的停靠时间，单位：分钟
`time`	`Number`	途径站点的进站时间，如大于24:00,则表示跨天

Rail _Stop 对象

属性	类型	说明
`name`	`String`	上、下车站点名称
`id`	`String`	上、下车站点ID
`location`	`LngLat`	上、下站点经纬度信息
`adcode`	`Number`	上、下车站点所在城市的adcode
`time`	`Number`	上下车点发车时间

Space 对象

属性	类型	说明
`type`	`Number`	仓位编码，参考仓位级别表
`cost`	`Number`	仓位费用

Alter 对象

属性	类型	说明
`id`	`Number`	备选方案ID
`name`	`String`	备选线路名称

公交类型列表

公交类型	说明
普通公交线路
地铁线路
轻轨线路
有轨电车
无轨电车
旅游专线
机场大巴
社区专车
磁悬浮列车线路
轮渡
索道交通
其他公交线路

火车路线类型表

公共交通工具备注	说明
普客火车
G字头的高铁火车
D字头的动车火车
C字头的城际火车
Z字头的直达特快火车
T字头的特快火车
K字头的快车火车
L字头，Y字头的临时火车
S字头的郊区线火车

仓位级别表

仓位备注	说明
不分仓位级别
特等座
火车硬座
火车软座
火车软座1等座
火车软座2等座
火车硬卧上铺
火车硬卧中铺
火车硬卧下铺

AMap.Walking

AMap.Walking步行导航服务，提供起始、终点步行路线查询服务。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败，系统将返回错误信息。

相关示例

构造函数	说明
`AMap.Walking (opts:WalkingOptions` `)`	构造函数，提供步行路径规划功能

WalkingOptions	类型	说明
`map`	`Map`	AMap.Map对象, 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上。可选参数
`panel`	`String\|HTMLElement`	结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。可选参数
`hideMarkers`	`Boolean`	设置隐藏路径规划的起始点图标，设置为true：隐藏图标；设置false：显示图标默认值为：false
`isOutline`	`Boolean`	使用map属性时，绘制的规划线路是否显示描边。缺省为true
`outlineColor`	`String`	使用map属性时，绘制的规划线路的描边颜色。缺省为'white'
`autoFitView`	`Boolean`	用于控制在路径规划结束后，是否自动调整地图视野使绘制的路线处于视口的可见范围

方法	返回值	说明
`search(origin:LngLat,destination:LngLat,` `callback:function(status:String,result:info/WalkingResult))` `或` `search(point:Array.<Object>,` `callback:function(status:String,result:info/WalkingResult))`		根据起点和终点坐标，实现步行导航规划；当按起点、终点名称时，point为包含起点、终点的数组，例：[{keyword:‘方恒国际中心A座’},{keyword:‘望京站’}] 当数组超过两个元素时，取前两个元素为起点、终点，其余元素忽略；当status为complete时，result为WalkingResult；当status为error时，result为错误信息info；当status为no_data时，代表检索返回0结果。
`clear()`		清除搜索的结果

方法

返回值

说明

search(origin:LngLat,destination:LngLat,

callback:function(status:String,result:info/WalkingResult))

或

search(point:Array.<Object>,

callback:function(status:String,result:info/WalkingResult))

根据起点和终点坐标，实现步行导航规划；

当按起点、终点名称时，point为包含起点、终点的数组，

例：[{keyword:‘方恒国际中心A座’},{keyword:‘望京站’}]

当数组超过两个元素时，取前两个元素为起点、终点，其余元素忽略；

当status为complete时，result为WalkingResult；

当status为error时，result为错误信息info；

当status为no_data时，代表检索返回0结果。

clear()

清除搜索的结果

事件	参数	说明
`complete`	`WalkingResult`	当查询成功时触发此事件
`error`	`ErrorStatus`	当查询失败时触发此事件
`searchOnAMAP(obj:Object)`		唤起高德地图客户端步行路径规划 obj参数形如：{ origin:LngLat,起点坐标 originName: "清华大学",起点名称 destination:LngLat,终点坐标 destinationName: "首开广场" 终点名称 }

事件

参数

说明

complete

WalkingResult

当查询成功时触发此事件

error

ErrorStatus

当查询失败时触发此事件

searchOnAMAP(obj:Object)

唤起高德地图客户端步行路径规划

obj参数形如：{ origin:LngLat,起点坐标

originName: "清华大学",起点名称

destination:LngLat,终点坐标

destinationName: "首开广场" 终点名称 }

WalkingResult 对象

属性	类型	说明
`info`	`String`	成功状态说明
`origin`	`LngLat`	步行导航起点坐标
`destination`	`LngLat`	步行导航终点坐标
`start`	`Poi`	步行导航起点
`end`	`Poi`	步行导航终点
`count`	`Number`	步行导航路段数目
`routes`	`Array.<WalkRoute>`	步行规划路线列表

WalkRoute 对象

属性	类型	说明
`distance`	`Number`	起点到终点总步行距离，单位：米
`time`	`Number`	步行时间预计，单位：秒
`steps`	`Array.<WalkStep>`	路段列表，以道路名称作为分段依据，将整个步行导航方案分隔成若干路段

WalkStep 对象

属性	类型	说明
`start_location`	`LngLat`	本路段的起点坐标
`end_location`	`LngLat`	本路段的终点坐标
`instruction`	`String`	此路段说明，如“沿北京南站路步行565米右转”
`distance`	`Number`	此路段距离，单位：米
`time`	`Number`	此路段预计使用时间，单位：秒
`path`	`Array.<LngLat>`	此路段坐标集合
`action`	`String`	本步行子路段完成后动作
`assist_action`	`String`	本步行子路段完成后辅助动作，一般为到达某个目的地时返回
`orientation`	`String`	步行方向
`road`	`String`	道路

AMap.Riding

AMap.Riding骑行路径规划服务，提供起始、终点骑行路线查询服务。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败，系统将返回错误信息。

相关示例

构造函数	说明
`AMap.Riding (opts:RidingOptions` `)`	构造函数，提供步行路径规划功能

RidingOptions	类型	说明
`map`	`Map`	AMap.Map对象, 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上。可选参数
`policy`	Number	骑行路线规划策略；可选值为： 0：推荐路线及最快路线综合 1：推荐路线 2：最快路线默认值：0
`panel`	`String\|HTMLElement`	结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。可选参数
`hideMarkers`	`Boolean`	设置隐藏路径规划的起始点图标，设置为true：隐藏图标；设置false：显示图标默认值为：false
`isOutline`	`Boolean`	使用map属性时，绘制的规划线路是否显示描边。缺省为true
`outlineColor`	`String`	使用map属性时，绘制的规划线路的描边颜色。缺省为'white'
`autoFitView`	`Boolean`	用于控制在路径规划结束后，是否自动调整地图视野使绘制的路线处于视口的可见范围

方法	返回值	说明
`search(origin:LngLat,destination:LngLat,` `callback:function(status:String,result:info/RidingResult))` `或 search(point:Array.<Object>,` `callback:function(status:String,result:info/RidingResult))`		根据起点和终点坐标，实现骑行路径规划；当按起点、终点名称时，point为包含起点、终点的数组，例：[{keyword:‘方恒国际中心A座’},{keyword:‘望京站’}] 当数组超过两个元素时，取前两个元素为起点、终点，其余元素忽略；当status为complete时，result为RidingResult；当status为error时，result为错误信息info；当status为no_data时，代表检索返回0结果。
`clear()`		清除搜索的结果

方法

返回值

说明

search(origin:LngLat,destination:LngLat,

callback:function(status:String,result:info/RidingResult))

或 search(point:Array.<Object>,

callback:function(status:String,result:info/RidingResult))

根据起点和终点坐标，实现骑行路径规划；

当按起点、终点名称时，point为包含起点、终点的数组，

例：[{keyword:‘方恒国际中心A座’},{keyword:‘望京站’}]

当数组超过两个元素时，取前两个元素为起点、终点，其余元素忽略；

当status为complete时，result为RidingResult；

当status为error时，result为错误信息info；

当status为no_data时，代表检索返回0结果。

clear()

清除搜索的结果

事件	参数	说明
`complete`	`RidingResult`	当查询成功时触发此事件
`error`	`ErrorStatus`	当查询失败时触发此事件

RidingResult 对象

属性	类型	说明
`info`	`String`	成功状态说明
`origin`	`LngLat`	骑行导航起点坐标
`destination`	`LngLat`	骑行导航终点坐标
`start`	`Poi`	骑行导航起点
`end`	`Poi`	骑行导航终点
`count`	`Number`	骑行导航路段数目
`routes`	`Array.<RideRoute>`	骑行规划路线列表

RideRoute 对象

属性	类型	说明
`distance`	`Number`	起点到终点总步行距离，单位：米
`time`	`Number`	步行时间预计，单位：秒
`rides`	`Array.<RideStep>`	路段列表，以道路名称作为分段依据，将整个骑行导航方案分隔成若干路段

RideStep 对象

属性	类型	说明
`start_location`	`LngLat`	本路段的起点坐标
`end_location`	`LngLat`	本路段的终点坐标
`instruction`	`String`	此路段说明，如“沿北京南站路骑行565米右转”
`distance`	`Number`	此路段距离，单位：米
`time`	`Number`	此路段预计使用时间，单位：秒
`path`	`Array.<LngLat>`	此路段坐标集合
`action`	`String`	本骑行子路段完成后动作
`assist_action`	`String`	本骑行子路段完成后辅助动作，一般为到达某个目的地时返回
`orientation`	`String`	步行方向
`road`	`String`	道路

AMap.DragRoute

拖拽导航插件。通过鼠标拖拽已有导航路径上的任一点，可以实现导航起点、途经点、终点的调整，系统根据调整后的起点、途经点、终点信息，实时查询拖拽后的导航路径并在地图上同步显示。支持驾车策略。建议途径点个数不超过16个，以保证良好的体验效果。

代码示例

JavaScript

mapObj = new AMap.Map("iCenter");
//绘制初始路径
var path = [];
path.push(new AMap.LngLat(116.303843,39.983412));
path.push(new AMap.LngLat(116.321354,39.896436));
path.push(new AMap.LngLat(116.407012,39.992093));
mapObj.plugin("AMap.DragRoute",function(){
    route = new AMap.DragRoute(mapObj, path, AMap.DrivingPolicy.LEAST_FEE); //构造拖拽导航类，传入参数分别为：地图对象，初始路径，驾车策略
    route.search(); //查询导航路径并开启拖拽导航
});

相关示例

构造函数	说明
`AMap.DragRoute(map:Map,path:Array.<LngLat>,policy:DrivingPolicy,opts:DragRouteOptions)`	DragRoute构造函数。参数Map为指定的地图对象，path指定导航的起点、途经点、终点的经纬度坐标数组，policy指定驾车策略。目前仅支持桌面浏览器

DragRouteOptions	类型	说明
`polyOptions`	`Object`	设置拖拽路线插件的路线属性对象，包括线样式、宽度、颜色等，参考PolylineOptions列表。
`startMarkerOptions`	`Object`	设置拖拽路线插件起点点标记属性对象，包括点标记样式、大小等，参考MarkerOptions列表。
`midMarkerOptions`	`Object`	设置拖拽路线插件途经点点标记属性对象，包括点标记样式、大小等，参考MarkerOptions列表列表。
`endMarkerOptions`	`Object`	设置拖拽路线插件终点点标记属性对象，包括点标记样式、大小等，参考MarkerOptions列表列表。
`showTraffic`	`Boolean`	设置显示实时路况信息，true：路线中显示实时路况信息，false：关闭实时路况信息默认值：true

方法	返回值	说明
`search( )`		开始路径导航。支持鼠标拖拽导航路径节点，更改途经点时，系统实时重新计算并显示导航路径
`getWays( )`	`Array.<LngLat>`	返回除了起点和终点之外的所有点
`getRoute( )`	`Array.<LngLat>`	返回当前导航路径，即导航路径的经纬度坐标数组，需要在complete回调中执行。
`destroy( )`		销毁拖拽导航插件。

事件	参数	说明
`addway`	`{type,lnglat,target}`	添加途经点触发的事件
`complete`	`{type,target,data}`	驾车路径规划完成时触发的事件，data同Driving驾车路线规划返回结果DrivingResult

驾车策略

DrivingPolicy	类型	说明
`LEAST_TIME`	Const	最快捷模式
`LEAST_FEE`	Const	最经济模式
`LEAST_DISTANCE`	Const	最短距离模式
`REAL_TRAFFIC`	Const	考虑实时路况

AMap.ArrivalRange

AMap.ArrivalRange根据输入的起点坐标和设定的时间范围，可以计算出用户在你设定的时间段内按公交出行方式，可以到达的距离范围。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败，系统将返回错误信息。

相关示例

构造函数	说明
`AMap.ArrivalRange()`	构造函数，示例化一个到达圈函数类

ArrivalRangeOptions	类型	说明
`policy`	`String`	公交出行策略,可选为：只坐地铁：SUBWAY, 只坐公交：BUS，缺省时为公交+地铁,BUS,SUBWAY
`resultType`	`String`	结果返回样式：polygon：返回多边形边界值，coverage：判断设定的终点坐标是否在到达圈范围内
`destination`	`LngLat\|Array.<LngLat>`	选择一个想到达的目的地坐标，最多支持5个目的地坐标

方法

返回值

说明

search(origin:LngLat,time:Number,

callback:function(status:String,result:info/ArrivalRangeResult),

opts:ArrivalRangeOptions)

计算某个时间段内用户通过公交出行可到达的距离范围

ArrivalRangeResult 对象

属性	类型	说明
`info`	`String`	查询状态说明
`bounds`	`Array`	输出方式选择polygon时，返回到达圈边界坐标点
`inRange`	`Boolean`	输出方式选择coverage时，返回提供的终点坐标是否在到达圈内

路径规划 最后更新时间: 2023年03月31日

AMap.Driving

驾车策略

AMap.TruckDriving

DrivingResult 对象

DriveRoute 对象

DriveStep 对象(基本信息)

DriveStep 对象(详细信息）

ViaCity 对象

District 对象

TMC 对象

AMap.Transfer

TransferPolicy 对象

TransferResult 对象

TransferPlan 对象

Segment 对象

WalkDetails 对象

WalkStep 对象

TransitDetails 对象

RailwayDetails 对象

TaxiDetails 对象

TransitLine 对象

SubwayEntrance 对象

Stop 对象

Via_Stop 对象

Rail _Stop 对象

Space 对象

Alter 对象

公交类型列表

火车路线类型表

仓位级别表

AMap.Walking

WalkingResult 对象

WalkRoute 对象

WalkStep 对象

AMap.Riding

RidingResult 对象

RideRoute 对象

RideStep 对象

AMap.DragRoute

代码示例

驾车策略

AMap.ArrivalRange

ArrivalRangeResult 对象

路径规划最后更新时间: 2023年03月31日