area - 友好速搭 -- 使用手册

友好速搭

JS SDK
简介 开始使用 接口列表

area

多级地区信息编码。

主要使用在收货人地址地区选择,大部分web端实现形式为省、市、地区三级联动的下拉选择。
SDK 中需要提交区域编码的接口(如:order.create 免登录下单中的 district_code),需使用本接口获取对应参数。
部分地区(如:新疆石河子)可能存在没有二级(市)或者三级(地区)的选项,故最终选出的结果不一定拥有完整的三级结构。提交时,请使用最后一级的编码。

接口中返回数据的层级关系:省(province) > 市(city) > 地区(district)。

API

.findNext(code, callback, whiteList)获取当前 code 对应的下级地区信息.findPrev(code, callback)获取当前 code 对应的地区信息与所有上级地区信息.getData(type, callback, whiteList)获取完整地区数据.config(options)配置地址数据

.findNext(code, callback, whiteList)

获取当前 code 对应的下级地区信息

    • code
    • 类型:String
      六位的地区编码。
    • callback
    • 类型:Function( 返回对象 )
      获取信息后的回调函数。如果返回空数组,则当前传入地区编码已是最后一级。
      传入无对应地区的六位编码,也会返回空数组。请保证传入编码的正确性。
    • whiteList
    • 类型:Array
      地址白名单。
      只需关注被允许区域的code,比如广东只允许深圳,只要填入深圳的code:440300。
      如果省份也只允许广东则要填入广东的code:440000,与填入code同级的区域会被自动过滤,要展示其他同级区域需手动填入。
      如果某一级没有填入code则会展示所有。

.findPrev(code, callback)

获取当前 code 对应的地区信息与所有上级地区信息

    • code
    • 类型:String
      六位的地区编码。
    • callback
    • 类型:Function( 返回对象 )
      获取信息后的回调函数。如果返回空对象,则当前传入地区编码无对应地区。
      {
          province : ["440000","广东",null],
          city : ["440300","深圳","440000"],
          district : ["440305","南山","440300"]
      }
      

.getData(type, callback, whiteList)

获取完整地区数据

    • type
    • 类型:String
      需要获取的地区信息类型。
      main - 省级单位,包括直辖市等。对应地区信息中的省(province)
      sub - 城市、地区等。对应地区信息中的市(city)、地区(district)
    • callback
    • 类型:Function( 返回对象 )
      返回对应的地区信息列表
    • whiteList
    • 类型:Array
      地址白名单。
      只需关注被允许区域的code,比如广东只允许深圳,只要填入深圳的code:440300。
      如果省份也只允许广东则要填入广东的code:440000,与填入code同级的区域会被自动过滤,要展示其他同级区域需手动填入。
      如果某一级没有填入code则会展示所有。

.config(options)

配置地址数据

    • options
    • 类型:Object
      配置选项(0.0.21版本添加,默认无需配置):
      areaDataUrl - 地址数据。文件格式为 .jsjsonp 方式加载,内容格式参照 //asset.ibanquan.com/common/js/areadata-160315.js
      areaDataVersion - 地址版本号。如果指定了 areaDataUrl 则此项必填,用于缓存数据。
      // 示例:配置繁体地址库
      yhsd.ready(jssdk => {
          jssdk.area.config({
              areaDataUrl: '//asset.ibanquan.com/common/js/areadata-170807tc.js',
              areaDataVersion: '170807tc'
          })
      })
      
以上内容仍未解决您的问题? 联系在线客服
免费领取15天试用
立即注册
联系客服
微信咨询
微信二维码

领取免费试用资格

姓名 *

电话 *

公司名称

所在地区

意向产品

提交

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!