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

Class:服务类/TransitRoute
构造函数
构造函数 描述
TransitRoute(location:Map|Point|KeyPoint|GbPoint|String[, opts:TransitRouteOptions]) 创建一个公交导航实例,其中location表示检索区域,类型可为地图实例、坐标点或城市名称。 (当参数为地图实例时,检索位置由当前地图中心点确定,且支持调整地图视野层级; 当参数为坐标时,检索位置由该点所在位置确定;当参数为城市名称时,检索会在该城市内进行。)
TransitRouteOptions
属性 类型 描述
map Map 展现结果的地图实例。当指定此参数后,搜索结果的标注、线路等均会自动添加到此地图上。
autoViewport Boolean 检索结束后是否自动调整地图视野(默认开启)。
autoDragging Boolean 是否开启起、终点拖拽自动规划公交功能(默认开启)。
autoDrawStep Boolean 是否开启自动绘制诱导点(默认开启)。
policy enum TransitPolicy 公交导航策略。
pageCapacity Number 返回方案的个数。
onSearchComplete Function 检索完成后的回调函数。 参数: results: TransitRouteResult
onMarkersSet Function 标注添加完成后的回调函数。 参数: pois: Array< LocalResultPoi> 起点和目的地点数组,通过marker属性可得到其对应的标注。 transfers: Array< LocalResultPoi>,公交车站数组。
onPolylinesSet Function 折线添加完成后的回调函数。 参数: lines: Array 公交线路数组。
onResultsHtmlSet Function 结果列表添加完成后的回调函数。参数:container: 结果列表所用的HTML 元素。
panel String 结果列表展示面板容器ID
方法
方法 返回值 描述
search(start:String|Point|KeyPoint|GbPoint,end:String|Point|KeyPoint|GbPoint[,options: Object]) none 公交检索。 ( start:起点,参数可以是关键字、坐标点。 end:终点,参数可以是关键字、坐标点。 options:可选对象参数)(自 1.1 新增)
getResults() TransitRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级,当指定了搜索结果所展现的地图时有效。
disableAutoViewport() none 禁用自动调整地图层级。
enableAutoDragging() none 开启起、终点拖拽自动规划公交功能,默认关闭。
disableAutoDragging() none 关闭起、终点拖拽自动规划公交功能。
setPageCapacity(capacity:Number) none 设置每页返回方案个数(1-5),默为5
setLocation(location:Map|Point|KeyPoint|GbPoint|String) none 设置检索范围,参数类型可以为地图实例、坐标点或城市名称。例:setLocation("北京市")
setPolicy(policy:TransitPolicy) none 设置公交规划策略,参数为策略常量
setSearchCompleteCallback(callback:Function) none 设置检索结束后的回调函数。 参数: results: TransitRouteResult
setMarkersSetCallback(callback:Function) none 设置添加标注后的回调函数。 参数: pois: Array 起点和目的地点数组,通过marker属性可得到其对应的标注。 transfers:Array,公交车站数组。
setPolylinesSetCallback(callback:Function) none 设置绘制路线后的回调函数。 参数: lines: Array,公交线路数组。
setResultsHtmlSetCallback(callback:Function) none 设置结果列表添加完成后的回调函数。 参数: container: 结果列表所用的HTML 元素。
getStatus() Object 返回检索结果状态。返回对象包含如下属性: errcode:Number,errmsg:String
TransitOptions
属性 类型 描述
startName String 起点自定义名称
endName String 终点自定义名称
p Number 交通工具,0:全部;1:公交;2:地铁(自 1.1 新增)
id Number 方案序号,从 1 开始。该参数用于标识只获取指定序号的路径,默认全部(自 1.1 新增)
st Number 出发时间,单位:分钟,如 7:30,则计算规则为:7*60+30=45(自 1.1 新增)
as Number 是否获取所有方案,0:获取当前时间可行案; 1:获取所有方案(包括已停运)(自 1.1 新增)
TransitPolicy
常量 描述
CLDMAP_TRANSIT_POLICY_LEAST_TIME 最少时间
CLDMAP_TRANSIT_POLICY_LEAST_TRANSFER 最少换乘
CLDMAP_TRANSIT_POLICY_LEAST_WALKING 最少步行
CLDMAP_TRANSIT_POLICY_AVOID_SUBWAYS 不乘地铁
CLDMAP_TRANSIT_POLICY_SYSTEM_DEFAULT 系统推荐(自 1.1 新增)
CLDMAP_TRANSIT_POLICY_PRIORITY_METRO 地铁优先(自 1.1 新增)