1. 总述

1.1 功能说明

组件通过组合省市区地址的选择框和详细地址的输入框获取地址数据。省市区选择框拥有级联样式与选择器样式,可以通过配置面板设置

省市区组件使用步骤如下:

  1. 如果有,加载上一次保存的地址数据,否则展示空白内容
  2. 通过配置的省市区选择框样式选择省市区内容,在选择到最子级地址后保存省市区数据
  3. 在下方的详细地址输入框输入详细地址
  4. 点击保存按钮存储数据

1.2 支持场景

各地区地址位置的选择与输入,可以自由适配国内或世界范围的地址接口

2. 组件构成

主要由两部分构成,分别是

  • ① 位于上部的省市区地址的选择框
  • ② 位于下部的详细地址的输入框

2.1 省市区地址选择框

①级联样式②选择器样式 两种,存储行政区域数据

在选择完最子级的地址后才能将选择的数据存储下来

2.2 详细地址的输入框

是一个多行文本框,存储详细地址数据

注:文本内容不允许输入英文逗号,会影响字段的分割

3. 配置

除了表单元素通用配置以外,省市区组件还有选择模式和接口地址两个配置属性

3.1 选择模式配置

选择模式可以通过开关选择

  • ① 级联样式
  • ② 选择器样式

3.2 接口地址配置

接口地址的默认测试地址为/v3/config/district
中间层转发地址为/apis/common/proxy/lcpGw/tz_api/data_amap
网络请求地址由二者组合拼成

4 接口参数

4.1 请求参数

请求方式: GET

请求参数:

关键词 描述
keywords 字符串类型 查询关键字 用于查询某一地址的子地址 默认为空 查询根结点地址
subdistrict 数字类型 返回子级行政区的层数 默认为 1 只返回一层子结点
filter 字符串类型 街道区域的名称和 adcode(区域编码)可能会重复,因此可填入当前省/直辖市的 adcode 进行过滤

请求示例:

{
    keywords: 广州,
    subdistrict: 1,
    filter: 广东
}

4.2 响应参数

响应参数:

关键词 描述
status 返回结果状态值 值为 0 或 1,0 表示失败;1 表示成功
info 返回状态说明 返回状态说明,status 为 0 时,info 返回错误原因,否则返回“OK”
infocode 状态码 返回状态说明,10000 代表正确
districts 行政区列表 为 district 的数组 内含数个 district
districts.district 行政区信息 属于 districts
districts.district.citycode 城市编码 属于 district
districts.district.adcode 区域编码 街道没有独有的 adcode,均继承父类(区县)的 adcode 属于 district
districts.district.name 行政区名称 属于 district
districts.district.level 行政区划级别 属于 district 类型有:
country 国家
province 省份(直辖市会在 province 和 city 显示)
city 市(直辖市会在 province 和 city 显示)
district 区县
street 街道
districts.district.isLeaf 地址是否为叶子结点 属于 district
districts.district.districts 下级行政区列表,包含 district 元素 属于 district

响应结果示例:

  {
      status: '1',
      info: 'OK',
      infocode: '10000',
      count: '1',
      districts: [
        {
          citycode: '020',
          adcode: '440100',
          name: '广州市',
          level: 'city',
          isLeaf: false,
          districts: [
            {
              citycode: '020',
              adcode: '440115',
              name: '南沙区',
              level: 'district',
              districts: [],
              isLeaf: false,
            },
            {
              citycode: '020',
              adcode: '440113',
              name: '番禺区',
              level: 'district',
              districts: [],
              isLeaf: false,
            },
            {
              citycode: '020',
              adcode: '440105',
              name: '海珠区',
              level: 'district',
              districts: [],
              isLeaf: false,
            },
            // ...省略其他区
          ],
        },
      ],
  }

5. 预览效果

5.1 级联选择模式

5.2 选择器模式

作者:袁子涵  创建时间:2022-11-25 16:08
最后编辑:黄泽彬  更新时间:2024-12-11 10:09