核心类
Subway
此类是地铁图API的核心类,用来实例化一个地铁图
Subway(container: String, citycode: String) |
在指定的DOM容器中创建地铁图实例,地铁图城市通过citycode决定,
如果未指定citycode如果当前城市不支持地铁图,默认显示北京市地铁图 |
setCity(citycode: String) |
none |
设置地铁图城市,如果当前城市不支持地铁图。 默认显示北京市地铁图 |
getCurrentCity() |
SubwayCity |
获取当前地铁图的城市citycode |
setCenter(station: String | Station) |
Boolean |
设置某地铁站为当前地铁图显示的的中心,如"北京西站", 该地铁站必须属于当前城市。如果设置成功返回true,失败返回false |
setZoom(zoom: Number) |
none |
设置地铁图缩放级别,zoom的可选范围为0.1到2之前,可以是小数 |
getZoom() |
Number |
返回当前地铁图缩放级别 |
zoomIn() |
none |
放大地铁图缩放级别 |
zoomOut() |
none |
缩小地铁图缩放级别 |
addMarker(marker:
Marker) |
none |
在地铁图上添加Marker覆盖物 |
removeMarker(marker:
Marker) |
none |
移除地铁图上的指定Marker覆盖物 |
clearMarkers() |
none |
清除地铁图上的所有Maker覆盖物 |
openInfoWindow(infoWindow: InfoWindow, station:
Station) |
none |
在地铁图上指定的station添加infoWindow覆盖物 |
closeInfoWindow() |
none |
移除地铁图上infoWindow覆盖物 |
clearOverlays() |
none |
移除地铁图上所有类型的覆盖物 |
getStation(station: String) |
Station |
获取当前地铁图中某个地铁站的对象 |
addControl(control: Control) |
none |
在地铁图中添加控件 |
removeControl(control: Control) |
none |
删除控件 |
getLines() |
Array<
Line> |
获取当前地铁图城市的所有地铁线路 |
subwayloaded |
none |
地铁图绘制完成后触发此事件 |
tap |
event{station} |
点击地铁图上某一地铁站后触发此事件 |
directioncomplete |
event{totalTime, totalStops, lines} |
线路规划面板,点击详情按钮后触发 |
SubwayCity
有地铁的城市对象,可直接通过BMapSub.SubwayCitiesList获得由SubwayCity组成的Array
keyword |
String |
城市的汉语拼音 |
name |
String |
城市中文名 |
cityCode |
String |
城市的cityCode,可用作初始化地铁图 |
基础类
Size
此类以像素表示一个矩形区域的大小
Size(width: Number, height: Number) |
以指定的宽度和高度创建一个矩形区域大小对象 |
width |
Number |
水平方向的数值 |
height |
Number |
竖直方向的数值 |
Line
此类标识一条地铁线路,没有构造函数。通过Subway的getLines获取
Station
此类表示一个地铁站,没有构造函数。通过Subway.getStation或点击事件的回调参数获取
name |
String |
地铁站名 |
city |
SubwayCity |
地铁站所在城市 |
col |
String |
当前站点默认颜色 |
ControlAnchor
此常量表示控件的定位
BMAPSUB_ANCHOR_TOP_LEFT |
控件将定位到地图的左上角 |
BMAPSUB_ANCHOR_TOP_RIGHT |
控件将定位到地图的右上角 |
BMAPSUB_ANCHOR_BOTTOM_LEFT |
控件将定位到地图的左下角 |
BMAPSUB_ANCHOR_BOTTOM_RIGHT |
控件将定位到地图的右下角 |
控件类
ZoomControl
缩放控件,通过点击控制地铁图的缩放
ZoomControlOptions
缩放控件配置对象
覆盖物类
Icon
此类表示标注所使用的图标
Icon(url: String, size:
Size, opts: IconOptions) |
以给定的图像地址和大小创建图标对象实例 |
anchor |
Size |
图标的定位点相对于图标左上角的偏移值,默认情况下, 图像的中下部对应位置点 |
Marker
此类表示一个标注。可以通过Subway.addMarker添加到地铁图上
show() |
none |
显示标注 |
hide() |
none |
隐藏标注 |
MarkerOptions
此类是Marker构造函数的可选参数。包含了对Marker的配置
服务类
DetailInfo
站点详情数据查询对象
search(station: String | Station) |
none |
查询某个站点的详细信息 |
DetailInfoOptions
站点详情数据查询配置对象
onSearchSuccess |
Function |
站点详情检索成功后的回掉函数,参数为Array
|
onSearchFail |
Function |
站点详情检索失败后的回掉函数 |
detailRenderOptions |
DetailRenderOptions |
站点详情检索中,和界面渲染相关的配置 |
DetailRenderOptions
站点详情检索中,和界面渲染相关的配置
autoRender |
Boolean |
站点详情检索完成后,是否进行详情面板渲染。默认为true |
DetailInfoResults
站点详情数据检索结果,主要包括站点所在的线路和首末班车信息
lineName |
String |
站点所在线路名称 |
startStation |
String |
当前行驶方向起点名称 |
endStation |
String |
当前行驶方向终点名称 |
firstTime |
String |
站点在当前线路上和行驶方向上的首班车时间 |
lastTime |
String |
站点在当前线路上和行驶方向上的末班车时间 |
Direction
地铁线路规划对象
search(start: String | Station, end: String | Station) |
none |
进行线路规划 |
DrctRenderOptions
线路规划和界面渲染相关的配置对象
detailText |
String |
线路规划完成后,自定义『详情』按钮的文字 |
detailClass |
String |
线路规划完成后,自定义『详情』按钮区域DOM的自定义class |
detailID |
String |
线路规划完成后,自定义『详情』按钮区域DOM的自定义ID |
Navigation
站点详情、线路规划整个功能打包类,支持采用默认样式,点选站点查看详情、点选起终点进行线路规划功能
setPoint(type: String, station:
Station) |
none |
手动设置station为起点或终点,type字段可选为start和end |
starttap |
event{station} |
点击弹窗中的"起点"后触发此事件 |
endtap |
event{station} |
点击弹窗中的"终点"后触发此事件 |
NavigationOptions
Navigation配置对象
startIcon |
Icon |
自定义起点图标 |
endIcon |
Icon |
自定义终点图标 |
addMarkers |
Boolean |
是否在点击起点、终点后,在地铁图中添加起终点图标, 默认为true。如果设置为false,可以监听起终点点击的时间对图标进行手动添加 |
drctOptions |
DrctOptions |
线路规划功能相关配置 |