类 BMapLib.CityList
城市列表类, 实例化该类后,可以帮助用户直接生成城市列表, 也可以通过接口获取城市数据。
源文件: CityList.js.
类
类 | 描述 |
BMapLib.CityList(opts)
|
CityList类的构造函数
|
方法
方法 | 返回值 | 描述 |
getBusiness(商圈名称, 回调函数,结果在回调函数中回传)
|
获取商圈数据
| |
getSubAreaList(回调函数,结果在回调函数中回传
) |
获取下级的区域列表
|
事件
事件 | 参数 | 描述 |
oncityclick(e)
|
{Event Object}
|
点击城市名时,派发事件的接口
|
类
BMapLib.CityList(opts)
CityList类的构造函数
参考示例:
var myCityListObject = new BMapLib.CityList({container : "container"});
-
参数:
{Json Object}
opts
-
可选的输入参数,非必填项。可输入选项包括:
{" container" : {String|HTMLElement} 需要提供界面方式展现的容器。如果此参数为空,则不提供界面方式,也没有cityclick的事件派发
" map" : {BMap} 实例化的map对象,如果传入此参数,则用户点击界面中的城市时,可以直接帮助用户定位到地图的相关城市位置}
方法详述
getBusiness(商圈名称, 回调函数,结果在回调函数中回传)
获取商圈数据
-
参数:
{String}
商圈名称
{Function}
回调函数,结果在回调函数中回传
-
[
{
city: "北京市", //商圈所在城市名
coordinate: {Array}, //商圈所在的坐标范围,Point数组
district: "海淀区", //商圈所在的区域
type: "4-优质商圈" //商圈的类型
}
]
getSubAreaList(回调函数,结果在回调函数中回传
)
)
获取下级的区域列表
-
参数:
{String}
城市代码(cityCode),参考百度地图城市名称-城市代码(cityCode)关系对照:http://developer.baidu.com/map/devRes.htm
{Function}
回调函数,结果在回调函数中回传
-
返回的json结果代表的意思
{
area_code: 131, //城市区域code
area_name: "北京市", //城市区域名称
area_type: 2, //城市区域类型
geo: {Point}, //城市区域中心点
sup_business_area: 0 ,//是否存在商圈,仅在区的级别(area_type=3)才会有此字段
sub: {Array} //下级区域列表, 里面内容同上面的那些字段
}
事件详述
oncityclick(e)
点击城市名时,派发事件的接口
参考示例:
myCityListObject.addEventListener("cityclick", function(e) { alert(e.area_name); });
-
参数:
{Event Object}
e
-
回调函数会返回event参数,包括以下返回值:
{" area_name : {String} 点击的区域名称,
{" area_code : {String} 点击的区域代码,
" geo:{BMap.Point} 点击区域合适显示的中心点位置,
" area_type:{Number} 该区域的类型(全国0、省1、城市2)