chanjet-plugin-geo
v1.0.4
Published
在mutants框架中, 提供定位相关的api , 只在chanjet平台上可用, 微信不提供此功能.
Downloads
2
Readme
定位API chanjet-plugin-geo
在mutants框架中, 提供定位相关的api , 只在chanjet平台上可用, 微信不提供此功能.
不能脱离mutants框架单独使用.
获取实例
//通过mutants来获取插件实例
const plugin = mutants.plugin.geo;
API
getLocation 获取当前位置
返回值
const result ={ resultCode : 0, message : '', body : { data : { //待补充 } } }
displayNearby 根据位置显示周边
参数
- options
Object
设置选项- longitude
string
经度 - latitude
string
纬度 - location
string
位置信息 - city
string
当前城市 - radius
number
周边半径 , 默认值 500 (米) , 最小值100
- longitude
- callback
function
执行完成后回调
注意: 查看周边可以再次选择周边的其他位置, 如果用户选择了周边的位置, 在回调中会返回选择的位置信息, 数据格式和
getLocation
一致- options
showLocation 在地图上显示位置
参数
- options
Object
设置选项- title
string
地图界面显示的标题 - longitude
string
经度 - latitude
string
纬度 - location
string
位置信息 - city
string
当前城市
- title
- options
用法
//获取插件实例
const plugin = mutants.plugin.geo;
/************** 获取当前位置 **************/
plugin.getLocation( (rs) => {
console.log(rs);
});
/************** 查看附近 **************/
const displayOptions = {
longitude: 40.06759,
latitude: 116.23624,
location: '北京市海淀区西北旺镇永腾南路用友软件园',
city: '北京市'
};
//调用查看附近
plugin.displayNearby( displayOptions , (rs) => {
console.log(rs);
});
/************** 在地图上查看位置 **************/
const showLocationOptions = {
title: '地理位置',
longitude: 40.06759,
latitude: 116.23624,
location: '北京市海淀区西北旺镇永腾南路用友软件园',
city: '北京市'
};
//在地图上查看位置
plugin.showLocation(showLocationOptions);
mock数据
在浏览器环境中,可以通过mock数据来模拟返回结果 , 可以使用 mutants.plugin.setMockData
来设置mock数据.
具体参考如下:
模拟成功
const mockData = {
//mock数据中,键名为插件的类名
GeoPlugin : {
//获取当前位置mock数据
getLocation : {
status : 'success',
data : {
accuracy: 29,
city: "010",
latitude: 40.067496,
location: "北京市海淀区永腾南路靠近用友软件园中区8D",
locationTimestamp: 1461722019140,
longitude: 116.236093
}
},
//查看附近选择mock数据
displayNearby : {
status : 'success',
data : {
accuracy: 0,
city: "010",
latitude: 40.066948,
location: "北京久瑞医疗科技有限公司",
locationTimestamp: 1461722134777,
longitude: 116.235596
}
}
}
}
//设置mock数据
mutants.plugin.setMockData(mockData);
模拟失败
const mockData = {
//mock数据中,键名为插件的类名
GeoPlugin : {
getLocation : {
status : 'failed',
message : '网络异常,请稍后再试'
},
displayNearby : {
status : 'failed',
message : '网络异常,请稍后再试'
}
}
}
//设置mock数据
mutants.plugin.setMockData(mockData);