README.md · PengJZ/js-citys

# js-citys

### 项目介绍
中国城市数据，支持省市区查询，支持浏览器、Node.js 环境

### 中国省市区数据调用示例

```
1. 导入js文件
<script type="text/javascript" src="dist/full-citys.js"></script>

或

const DC = require('./dist/node/full-citys.js');

2. 相关api

//获取省份列表
var provs = DC.getProvs();  //=> [{ id: 17, name: "湖北" }, ...]

//获取城市列表
var citys = DC.getCitys(prov_id);   //=> [{ id: 0, code: "CN101200101", name: "武汉" }, ...]

//获取区域列表
var areas = DC.getAreas(prov_id, city_id);   //=> [{ id: 11, code: "CN101200113", name: "洪山" }, ...]

//获取省份对象
var data_prov = DC.getAuto(prov_id);  //=> { id: 17, name: "湖北" }

//获取城市对象
var data_city = DC.getAuto(prov_id, city_id);  //=> { pid: 17, id: 0, code: "CN101200101", name: "武汉" }

//获取区域对象
var data_area = DC.getAuto(prov_id, city_id, area_id);  //=> { pid: 17, cid: 0, id: 11, code: "CN101200113", name: "洪山" }

//格式化省市区对象
var data_prov = DC.formatData(data_prov);  //=> { type: 2, pid: 17, prov: "湖北"}
var data_city = DC.formatData(data_city);  //=> { type: 3, pid: 17, prov: "湖北", cid: 0, city: "武汉", code: "CN101200101"}
var data_area = DC.formatData(data_area);  //=> { type: 4, pid: 17, prov: "湖北", cid: 0, city: "武汉", aid: 11, area: "洪山", code: "CN101200113"}

var Types = DC.Types;
data_prov.type == Types.prov;  //=>  true
data_city.type == Types.city;  //=>  true
data_area.type == Types.area;  //=>  true

//根据城市或区域代码获取对象
var data_city = DC.getCityOrArea("CN101200101");  //=> { type: 3, pid: 17, prov: "湖北", cid: 0, city: "武汉", code: "CN101200101"}
var data_area = DC.getCityOrArea("CN101200113");  //=> { type: 4, pid: 17, prov: "湖北", cid: 0, city: "武汉", aid: 11, area: "洪山", code: "CN101200113"}

//查找省份对象，支持模糊查找
DC.find("湖北省");
DC.find("湖北");
DC.find("湖北电信");

//=>  { type: 2, pid: 17, prov: "湖北"}

//查找城市对象，支持模糊查找
DC.find("湖北省武汉市");
DC.find("湖北武汉电信");
DC.find("湖北武汉");
DC.find("武汉");

//=>  { type: 3, pid: 17, prov: "湖北", cid: 0, city: "武汉", code: "CN101200101"}

//查找区域对象，支持模糊查找
DC.find("湖北省武汉市洪山区");
DC.find("湖北武汉洪山电信");
DC.find("湖北武汉洪山");
DC.find("武汉市洪山区");
DC.find("武汉洪山电信");
DC.find("武汉洪山");
DC.find("湖北洪山");
DC.find("洪山");

//=>  { type: 4, pid: 17, prov: "湖北", cid: 0, city: "武汉", aid: 11, area: "洪山", code: "CN101200113"}

//查找省市区对象，精确查找
DC.findData("湖北");  //=>  { type: 2, pid: 17, prov: "湖北"}
DC.findData("湖北", "武汉");  //=>  { type: 3, pid: 17, prov: "湖北", cid: 0, city: "武汉", code: "CN101200101"}
DC.findData("湖北", "武汉", "洪山");  //=>  { type: 4, pid: 17, prov: "湖北", cid: 0, city: "武汉", aid: 11, area: "洪山", code: "CN101200113"}
```

PengJZ/js-citys

简介

发行版

贡献者

近期动态

PengJZ/js-citys .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

PengJZ/js-citys