参考手册 最后更新时间: 2021年01月22日
subway构造函数
构造函数 |
说明 |
---|---|
subway(id,opts) |
其中id为容器的id; opts为地铁图可选参数对象,包括 easy: 表示是否开启简易模式,true表示开启,false表示不开启。默认为false,即:不开启。 adcode: 表示默认展示的地铁图城市adcode,默认为1100(北京),adcode可以通过getCityList方法获取。 theme: 主题,目前支持两种主题模式,’normal’(标准)和’colorful’(站点颜色跟随线路颜色),默认为’normal’。 doubleclick: 表示是否开启双击放大模式,{switch: false} 表示不开启,{switch: true}表示开启。默认为不开启。 |
subway 基本功能
当对地铁图图面元素进行新增或删除时,会用到如下接口:
方法 |
参数 |
返回值 |
说明 |
---|---|---|---|
setAdcode (adcode) |
adcode:城市编码 |
设置adcode(城市编码)如不设置,则默认为北京。 |
|
getLineList (callback) |
callback:回调函数 |
线路列表 |
获得当前城市所有线路(已排序) |
getCityList(callback) |
callback:回调函数 |
城市列表 |
获取当前开通地铁线路的城市列表对象。该对象的key为每个城市的adcode,value为城市的中文名和英文名。 |
getNearStation (param) |
param:param是配置项,现在只支持一个参数, lnglat,是一个经纬度的对象,经纬度之间用逗号隔开。 例如: subwayApi.getNearStation({lnglat: ‘116.3191270000,39.9766230000’}) |
返回最近的站点ID |
获取离传入坐标最近的站点。如果传入的坐标点直线距离10KM内没有地铁站的话,此时会返回false。 |
showLine (id) |
id:线路的id |
根据指定的id来展现对应的线路。 |
|
clearLine() |
清除当前显示的地铁线 |
||
addInfoWindow (id, opts) |
id:站点的id或者名称(中文名称,与地铁图展示名称一致); opts:目前支持偏移量offset,格式为:{x:0,y:0}; 默认偏移量为0,单位为屏幕像素。 |
打开一个infowindow |
|
clearInfoWindow() |
关闭infowindow |
||
addMarker (id, opts) |
id:站点的id或者站点名称(中文名称,与地铁图展示名称一致);opts:支持自定义marker属性 |
在站点之上添加marker |
|
clearMarker (id) |
id:站点的id或者站点名称(中文名称,与地铁图展示名称一致); |
清除指定站点上的marker |
|
route(start, end,opts) |
start:起点站;end:终点站;opts:是否展示“清除”按钮,默认为有。 closeBtn为true时,展示右上角的关闭按钮;为false时,不展示关闭按钮。 |
根据制定的起点和终点进行路径规划 |
|
clearRoute() |
清除当前的路径规划 |
||
clearOverlays() |
清除当前地铁图上的所有覆盖物,包括窗口、marker和线路。 |
||
setStart(id, opts) |
id:指定的站点id或者站点名称(中文名称,与地铁图展示名称一致);opts:支持自定义marker属性 |
设置起点 |
|
setEnd(id, opts) |
id:指定的站点id或者站点名称(中文名称,与地铁图展示名称一致);opts:支持自定义marker属性 |
设置终点 |
subway 图面交互
当需要对地铁图显示进行调整时,会用到如下接口:
方法 |
参数 |
返回值 |
说明 |
---|---|---|---|
setCenter(center) |
center:地铁站或地铁线路的中心点 |
设置中心点。该接口用于将指定的地铁站或线路设置在地图的中央展示。 |
|
setFitView (obj) |
obj: 选中的站点或线路的DOM |
调整视图到合适的显示范围。 |
|
scale(scale) |
scale:指定的缩放级别 |
对地铁图进行缩放,缩放级别0.3~1.3 |
|
move(deltaX, deltaY) |
deltaX:地铁图X轴偏移量,单位为像素; deltaY:地铁图Y轴偏移量,单位为像素 |
对地铁图进行偏移 |
subway 数据
当需要进行地铁数据请求时,会用到如下接口:
方法 |
参数 |
返回值 |
说明 |
---|---|---|---|
stationSearch(keyword, callback) |
keyword:指定的站点名关键词;callback:回调函数 |
站点列表 |
根据指定的参数搜索站点. |
getStCenter (id) |
站点id或者站点名称(中文名称,与地铁图展示名称一致) |
坐标对象 |
根据站点id获取站点的中心位置 |
getSelectedLineCenter() |
坐标对象 |
获取选中的地铁线的中心点 |
|
getIdByName(name , type) |
name: 站点名称;type: “line”,”station”,(该参数为选填) |
ID |
根据名称获取id |
subway事件
事件 |
说明 |
---|---|
subway.zoom |
地铁图缩放 |
subway.drag |
地铁图拖动 当Move事件结束时,会触发DRAG事件。 |
subway.move |
移动地铁图操作(类似鼠标事件) |
lineName.touch |
地铁线路名 |
subway.touch |
点触地铁图 |
station.touch |
点击站点事件 |
stationName.touch |
点击站点名称事件 |
startStation.touch |
选择起点站事件 |
endStation.touch |
选择终点站事件 |
subway.complete |
subway初始化完毕后会触发该事件 |
subway.routeComplete |
路径规划完毕后触发此事件 |