Skip to content

Latest commit

 

History

History
239 lines (196 loc) · 7.32 KB

README.md

File metadata and controls

239 lines (196 loc) · 7.32 KB
Raw

Geografis

Sebuah modul Node.js yang mengandung data kode wilayah desa/kelurahan, kecamatan, kabupaten/kota, provinsi, kode pos, koordinat, elevasi, dan geometri area seluruh Indonesia. Data yang terdapat dalam repository ini sesuai dengan Peraturan Menteri Dalam Negeri No. 72 Tahun 2019 dan Peraturan Menteri Dalam Negeri No. 146.1-4717 Tahun 2020.

npm version Downloads License MIT

Instalasi

Anda dapat menggunakan modul ini pada lingkungan Node.js (tidak untuk browser) dengan cara sebagai berikut:

npm install geografis

Jika Anda menggunakan Yarn:

yarn add geografis

Struktur Data

Setiap entri mengandung data yang terdiri atas nama kelurahan/desa, kecamatan, kabupaten/kota, provinsi, latitude, longitude, elevasi, kode pos, geometri (GeoJSON, beberapa tidak tersedia) dan Kode Wilayah. Pustaka ini mengandung 83,449 jumlah entri. Berikut ini adalah contoh keluaran data:

{
  "code": "31.71.01.1001",
  "postal": 10110,
  "slug": "dki-jakarta/kota-administrasi-jakarta-pusat/gambir/gambir",
  "province": "DKI Jakarta",
  "city": "Kota Administrasi Jakarta Pusat",
  "district": "Gambir",
  "village": "Gambir",
  "latitude": -6.176262870636918,
  "longitude": 106.82932428386471,
  "elevation": 5,
  "geometry": true
},
Field Keterangan
code Kode wilayah
postal Kode pos dari wilayah tersebut
slug Slug untuk wilayah tersebut
province Nama Provinsi
city Nama Kota/Kabupaten
district Nama Kecamatan
village Nama Desa/Kelurahan
latitude Latitude dari wilayah
longitude Longitude dari wilayah
elevation Elevasi wilayah dalam meter
geometry Apakah wilayah memiliki file geometri (poligon)

Penggunaan

⚙️ Fungsi geografis.dump()

Mendapatkan semua data kelurahan/desa dari database. Penggunaan:

const geografis = require('geografis');
const dump = geografis.dump();
console.log(dump)

⚙️ Fungsi geografis.search(query, limit, offset)

Mencari kode wilayah, kode pos, nama desa/kelurahan, kecamatan, dan kota menggunakan elasticlunr.js (sedikit berat). Penggunaan:

const geografis = require('geografis');
const query = "ciumbuleuit bandung"
const search = geografis.search(query, 10, 0);
console.log(search)

Contoh keluaran:

{
  "count": 1,
  "limit": 10,
  "offset": 0,
  "data": [
    {
      "code": "31.71.01.1001",
      "postal": 10110,
      "slug": "dki-jakarta/kota-administrasi-jakarta-pusat/gambir/gambir",
      "province": "DKI Jakarta",
      "city": "Kota Administrasi Jakarta Pusat",
      "district": "Gambir",
      "village": "Gambir",
      "latitude": -6.176262870636918,
      "longitude": 106.82932428386471,
      "elevation": 5,
      "geometry": true
    }
  ]
}

⚙️ Fungsi geografis.getProvinces()

Mendapatkan list nama-nama provinsi. Penggunaan:

const geografis = require('geografis'); 
const provinces = geografis.getProvinces();
console.log(provinces)

⚙️ Fungsi geografis.getProvince(code)

Mendapatkan detil provinsi berdasarkan kode wilayah (parameter code). Penggunaan:

const geografis = require('geografis'); 
const province = geografis.getProvince('32');
console.log(provinces)

⚙️ Fungsi geografis.getProvinceBySlug(slug)

Mendapatkan detil provinsi berdasarkan slug (parameter slug). Penggunaan:

const geografis = require('geografis'); 
const province = geografis.getProvinceBySlug('dki-jakarta');
console.log(provinces)

⚙️ Fungsi geografis.getCity(code)

Mendapatkan detil kota/kabupaten berdasarkan kode wilayah (parameter code). Penggunaan:

const geografis = require('geografis'); 
const city = geografis.getCity('31.71');
console.log(city)

⚙️ Fungsi geografis.getCityBySlug(slug)

Mendapatkan detil provinsi berdasarkan slug (parameter slug). Penggunaan:

const geografis = require('geografis'); 
const city = geografis.getCityBySlug('jawa-barat/kota-bandung');
console.log(city)

⚙️ Fungsi geografis.getDistrict(code)

Mendapatkan detil kecamatan berdasarkan kode wilayah (parameter code). Penggunaan:

const geografis = require('geografis'); 
const district = geografis.getDistrict('31.71.01');
console.log(district)

⚙️ Fungsi geografis.getDistrictBySlug(slug)

Mendapatkan detil kecamatan berdasarkan slug (parameter slug). Penggunaan:

const geografis = require('geografis'); 
const district = geografis.getDistrictBySlug('jawa-barat/kota-bandung/coblong');
console.log(district)

⚙️ Fungsi geografis.getVillage(code)

Mendapatkan detil desa/kelurahan berdasarkan kode wilayah (parameter code). Penggunaan:

const geografis = require('geografis'); 
const village = geografis.getVillage('31.71.01.1001');
console.log(village)

⚙️ Fungsi geografis.getVillageBySlug(slug)

Mendapatkan detil desa/kelurahan berdasarkan slug (parameter slug). Penggunaan:

const geografis = require('geografis'); 
const village = geografis.getVillageBySlug('jawa-barat/kota-bandung/cidadap/hegarmanah');
console.log(village)

⚙️ Fungsi geografis.getVillageByPostalCode(postalCode)

Mendapatkan detil desa/kelurahan berdasarkan slug (parameter postalCode). Penggunaan:

const geografis = require('geografis'); 
const village = geografis.getVillageByPostalCode(40142);
console.log(village)

⚙️ Fungsi geografis.getNearest(latitude, longitude)

Mendapatkan desa/kelurahan terdekat (parameter latitude, longitude). Berguna untuk mendeteksi area. Penggunaan:

const geografis = require('geografis'); 
const village = geografis.getNearest(-6.8822007,107.6142733);
console.log(village)

⚙️ Fungsi geografis.getGeometry(code)

Untuk menggunakan fungsi ini, Anda harus mengunduh data geojson yang terdapat di repository ini. Simpan di dalam direktori: project_anda / data / geojson. Penggunaan:

const geografis = require('geografis'); 
const json = geografis.getGeometry('32.73.08.1002');
console.log(json)

Test

Unduh modul ini dan jalankan:

yarn test

Berkontribusi

Gunakan fitur Issues jika ada masalah, ada pertanyaan, atau kirimkan Pull Request jika ingin berkontribusi. Anda juga dapat mentranslasikan pustaka kode ini ke bahasa pemrograman yang lain.

Lisensi

SUMBER KODE YANG TERDAPAT DALAM REPOSITORY INI BERLISENSI MIT, TIDAK TERDAPAT JAMINAN DARI PEMBUAT KODE UNTUK MEMASTIKAN KEAKURATAN, KUALITAS, DAN KETERSEDIAAN. DIMOHON TIDAK MEMPERJUALBELIKAN DATA YANG TERDAPAT DALAM REPOSITORY INI UNTUK KEPENTINGAN PRIBADI DAN GUNAKANLAH DENGAN BIJAK.

Sumber kode dibuat untuk pembelajaran karena sulitnya memperoleh informasi area yang komprehensif serta akurat di Indonesia yang terbuka dan bebas digunakan.

Sumber

Data diperoleh dan telah diproses secara otomatis dan manual dari berbagai sumber.

  1. Wilayah
  2. Kebijakan Satu Peta
  3. Open Elevation
  4. OSM
  5. Nomor

Star repository ini jika bermanfaat ya ges ya 🇮🇩