/lcn

中华人民共和国行政区划，省市区数据

Primary LanguageTypeScriptMIT LicenseMIT

lcn

npm GitHub

中华人民共和国行政区划，省市区数据

数据来源

当前数据

多种数据格式

如果在客户端中使用，并且没有用到全部数据，建议保存对应数据到本地。比如只用到省市联动数据，将 pc.json 保存本地即可。

文件 数据格式 描述
pca.json Array<{code, name, children?}> 省/市/区三级联动数据
pc.json Array<{code, name, children?}> 省/市二级联动数据
data.json Array<{code, name}> 全部数据
provinces.json Array<{code, name}> 省份数据
cities.json Array<{code, name}> 市级数据
areas.json Array<{code, name}> 区级数据

使用

安装

npm install lcn

or

yarn add lcn

示例

import { data, getPCA, getPC, getProvinces, getCities, getAreas } from "lcn";

const pca = getPCA({ formatForm: true }); // 获取省市区三级联动表单格式数据
console.log(pca);

文档

getPCA(options)

  • options <Object> 配置项
  • options.inland <boolean> 仅包含内地数据。默认为 false
  • options.formatForm <boolean> 数据处理为表单格式，即 { value, label, children? }。默认为 false

获取省/市/区三级联动数据。

formatForm 为 true 时，数据可直接用于 antd element-ui 的表单组件中。

import { getPCA } from "lcn";

const data1 = getPCA();
console.log(data1);

[
  {
    code: "110000",
    name: "北京市",
    children: [
      // ...
    ],
  },
  // ...
  { code: "710000", name: "**省" },
  { code: "810000", name: "香港特别行政区" },
  { code: "820000", name: "澳门特别行政区" },
];

const data2 = getPCA({ inland: true, formatForm: true });
console.log(data2);

[
  {
    value: "110000",
    label: "北京市",
    children: [
      // ...
    ],
  },
  // ...
];

getPC(options)

  • options <Object> 配置项
  • options.inland <boolean> 仅包含内地数据。默认为 false
  • options.formatForm <boolean> 数据处理为表单格式，即 { value, label, children? }。默认为 false

获取省/市二级联动数据。其余同 getPCA 方法。

data

全部数据，无级联。

[
  { code: "110000", name: "北京市" },
  { code: "110100", name: "北京市" },
  { code: "110101", name: "东城区" },
  { code: "110102", name: "西城区" },
  // ...
];

getProvinces()

获取全部省份数据。

[
  { code: "110000", name: "北京市" },
  { code: "120000", name: "天津市" },
  // ...
];

getCities()

获取全部市级数据。

[
  // ...
  { code: "130100", name: "石家庄市" },
  { code: "130200", name: "唐山市" },
  { code: "130300", name: "秦皇岛市" },
  // ...
];

getAreas()

获取全部区级数据。

[
  { code: "110101", name: "东城区" },
  { code: "110102", name: "西城区" },
  { code: "110105", name: "朝阳区" },
  // ...
];

注意，以下数据修正

1. 直辖市补充市级数据

  • 北京市(110000)
    • 北京市(110100)
  • 天津市(120000)
    • 天津市(120100)
  • 上海市(310000)
    • 上海市(310100)
  • 重庆市(500000)
    • 重庆市(500100)

2. 部分省补充县级行政区划

3. 海南省三沙市补充区级数据

数据源自国家统计局 - 统计用区划和城乡划分代码

  • 海南省(460000)
    • 三沙市(460300)
      • 西沙群岛(460321)
      • 南沙群岛(460322)
      • 中沙群岛的岛礁及其海域(460323)

4. 以下几个特殊地级市，属于“不设区的市”：

  • 广东省东莞市(441900)
  • 广东省中山市(442000)
  • 甘肃省嘉峪关市(620200)
  • 海南省儋州市(460400)

参考