my.regionpicker(object object)
支付宝客户端 10.1.90 或更高版本； 若版本较低，建议采取 兼容处理 。
支小宝客户端 支持
安诊儿客户端 支持
小程序开发者工具： 支持。
主体： 企业支付宝小程序 、 个人支付宝小程序
唤起多级省市区选择器，自带省市区数据源。
object object
查看示例
| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | string | - | 否 | - | 标题 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customitems | array |
- | 否 | 支付宝: 10.5.26 |
自定义选项。按顺序分别在省市区三列的列头插入一个自定义选项。注意：数组长度必须为 3。自定义省的列头时，必须同时自定义市区列头；自定义市的列头时，必须同时自定义区列头，以保证选择器的数据完整性 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| mergeoptions | object | - | 否 | - | 自定义修改城市数据，支持删除、添加和更新城市信息，不会全局生效，仅单次生效 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| selecteditem | array |
- | 否 | - | 初始选中的省市区名称。不传则默认选中第一个。例：['广东', '深圳', '福田区'] |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| success | function | - | 否 | - | 调用成功的回调函数 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fail | function | - | 否 | - | 调用失败的回调函数 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| complete | function | - | 否 | - | 调用结束的回调函数（调用成功、失败都会执行） |
success 回调函数
参数
object res
查看示例
| 属性 | 类型 | 描述 |
|---|---|---|
| data | array |
选择的省市区名称数组 |
| code | array |
选择的省市区 id 数组 |
fail 回调的参数为 object，error 属性为错误码，errormessage 属性为错误消息。
| 错误码 | 错误消息 | 凯发app官方网站的解决方案 |
|---|---|---|
| 2 | customitems参数错误 |
请检查 customitems 参数，确保数据完整。 |
| 11 | 取消选择 |
这是用户正常交互流程分支，不需要特殊处理。 |
my.regionpicker({
customitems:["全国","全省","全市"],
mergeoptions: {
// 新增
add: [
{
pid: '340000',
id: 'x1',
name: '新市',
nextid: '340800',
sublist: [
{
name: '新区',
id: 'x11',
},
],
},
],
// 删除
remove: [
{
id: '330000',
},
],
// 更新
update: [
{
id: '110000',
name: '北京',
sublist: [
{
name: '北京市',
id: '110100',
sublist: [
{
name: '东城区',
id: '110101',
},
],
},
],
},
],
},
selecteditem: ['广东', '深圳', '福田区'],
success: res => {
console.log(res)
},
fail: error =>{
console.log(error)
}
});
{
"data": ["重庆", "重庆", "璧山区"],
"code": ["500000", "500100", "500120"]
}
q：可以获取 my.regionpicker 中的省市区数据吗？
不能直接通过 my.regionpicker 获取省市区数据，只能作为选择器使用。可以通过 获取最新行政区信息。
q：my.regionpicker 不包含最新的行政区信息怎么办？
可以通过 mergeoptions 参数自定义修改城市数据，支持删除、添加和更新城市信息。