search

cognitom / tokoro

住所緯度経度変換ライブラリ (ジオコーディング)
http://cognitom.github.io/tokoro/
94 stars 4 forks source link

readme

tokoro

Japanese geocoding library for front-end and node/io.js.

国土交通省のデータを元にしたオープンな、住所緯度経度変換ライブラリ(ジオコーダー)です。フロントエンドから、あるいはNode/io.jsのモジュールとして利用可能です。 OpenStreetMapと組み合わせると、簡単に住所から地図表示させることができます。

特徴

実装と制限について

インストール

npmには位置参照データを置いていません。モジュールとしてインストールする際に、GitHub Pagesにホストされているデータを自動的にダウンロードして取り込みます。そのため、curlとunzipコマンドが環境にインストールされている必要があります。

$ npm install --save tokoro

使い方

クライアントサイドで使う

データファイルは同一ドメインに置くか、CORS設定してください。

<script src="https://github.com/cognitom/tokoro/raw/master/dist/tokoro.js"></script>
<script>
  tokoro({ data: 'data' })
  tokoro('東京都世田谷区粕谷一丁目25', function(code) {
    if (code) {
      console.log('緯度', code[0]) // 35.662696
      console.log('経度', code[1]) // 139.614003
    } else {
      console.log('見つからないよ!')
    }
  })
</script>

なお、IE9にも対応させる場合は、PolyfillとしてjDataViewとjBinaryが必要です。<head>内に次の記述を追加します。

<!--[if lt IE 10]>
<script src="https://jdataview.github.io/dist/jdataview.js"></script>
<script src="https://jdataview.github.io/dist/jbinary.js"></script>
<![endif]-->

Node/io.jsから使う

var tokoro = require('tokoro')

tokoro('東京都世田谷区粕谷一丁目25', function(code) {
  if (code) {
    console.log('緯度', code[0]) // 35.662696
    console.log('経度', code[1]) // 139.614003
  } else {
    console.log('見つからないよ!')
  }
})

住所の形式について

基本的には国交省データの形式に準拠します。半角全角の表記揺れに対応しているほか、次のような丁目番地の表記揺れにもある程度対応します。空白文字は無視します。都道府県名は必須です。

開発者向けの情報

以下の手順は、利用だけする場合は不要です。開発に加わる場合、自前でデータを変換する必要がある場合に参考にしてください。

コマンド

上記以外のコマンドは、gulpfileおよびtaskディレクトリ内を参照のこと。

データについて

国土交通省の公開している街区レベル位置参照データを元にします。

ライセンス

Changelog