本 API がブラウザで使えるかどうかを調べます。

※本メソッドは改善中であり必ずしも結果を保証するものではありません。

本 API のバージョンです。バージョンは "1.2.3" のように3つの数値をピリオドで区切って表します。 左からメジャー、マイナー、バグフィックスの改訂数を表します。

検索オブジェクトを生成します。必要に応じて次のオプションを指定します。

number timeout

send メソッドのタイムアウト時間を秒単位で指定します。初期値は30秒です。タイムアウトすると onerror イベントが発生します。

指定した郵便番号の住所を検索します。検索は非同期です。検索が成功すると onload イベントが、失敗すると onerror イベントが発生します。

※Opera など検索が同期になるブラウザもあります。このときイベントは send メソッド中に発生します。

郵便番号は "123-4567" もしくは "1234567" の書式(半角文字)で指定します。郵便番号の書式に誤りがあるときは、検索を abort して戻り値に false を返します。このときイベントは発生しません。

検索中の検索(多重検索)は、最後の検索のみ有効です。直前の検索は abort します。このときイベントは発生しません。

検索結果です。検索結果は住所のオブジェクトの配列です。住所のオブジェクトは、次のプロパティを持ちます。

string c

郵便番号です。"1234567" といった7桁の数字からなる文字列です。

string a

住所です。

string k

住所のフリガナ(全角カナ)です。

string g

住所の全国地方公共団体コードです。"14104" といった5桁の数字からなる文字列です。

number x

住所の経度です。139.704268 といった世界測地系を表す数値です。

number y

住所の緯度です。35.693312 といった世界測地系を表す数値です。

住所が見つからないときは、要素数が0の配列になります。複数の住所が見つかったときは、要素数が2以上にもなります。

検索結果は onload イベントもしくは onerror イベントの中でのみ有効です。

HTTPレスポンスのステータスコードです。ステータスコードは "200 OK" のとき 200、"408 Request Timeout" のとき 408 といった3桁の数値です。

ステータスコードは onload イベントもしくは onerror イベントの中でのみ有効です。

HTTPレスポンスのステータステキストです。ステータステキストは "200 OK" のとき "OK"、"408 Request Timeout" のとき "Request Timeout" といった文字列です。

ステータステキストは onload イベントもしくは onerror イベントの中でのみ有効です。

検索が成功したときに発生するイベントです。イベントの引数は検索オブジェクトです。検索結果は、検索オブジェクトの response プロパティから取得します。

検索が失敗したときに発生するイベントです。失敗の原因は、検索オブジェクトの status プロパティや statusText プロパティから取得します。

検索オブジェクトを生成します。必要に応じて次のオプションを指定します。

number timeout

send メソッドのタイムアウト時間を秒単位で指定します。初期値は30秒です。タイムアウトすると onerror イベントが発生します。

指定した住所の単語から郵便番号を検索します。検索は非同期です。検索が成功すると onload イベントが、失敗すると onerror イベントが発生します。

※Opera など検索が同期になるブラウザもあります。このときイベントは send メソッド中に発生します。

住所の単語は "横浜" や "新宿" といった1語を指定します。住所の単語が空(スペースを含む)のときは、検索を abort して戻り値に false を返します。このときイベントは発生しません。

検索中の検索(多重検索)は、最後の検索のみ有効です。直前の検索は abort します。このときイベントは発生しません。

検索結果です。検索結果は住所のオブジェクトの配列です。住所のオブジェクトは、次のプロパティを持ちます。

string c

郵便番号です。"1234567" といった7桁の数字からなる文字列です。

郵便番号が見つからないときは、要素数が0の配列になります。複数の郵便番号が見つかったときは、要素数が2以上にもなります。

検索結果は onload イベントもしくは onerror イベントの中でのみ有効です。

HTTPレスポンスのステータスコードです。ステータスコードは "200 OK" のとき 200、"408 Request Timeout" のとき 408 といった3桁の数値です。

ステータスコードは onload イベントもしくは onerror イベントの中でのみ有効です。

HTTPレスポンスのステータステキストです。ステータステキストは "200 OK" のとき "OK"、"408 Request Timeout" のとき "Request Timeout" といった文字列です。

ステータステキストは onload イベントもしくは onerror イベントの中でのみ有効です。

検索が成功したときに発生するイベントです。イベントの引数は検索オブジェクトです。検索結果は、検索オブジェクトの response プロパティから取得します。

検索が失敗したときに発生するイベントです。失敗の原因は、検索オブジェクトの status プロパティや statusText プロパティから取得します。

プラグインのオプションを指定します。必要に応じて次のオプションを指定できます。

number timeout

タイムアウト時間を秒単位で指定します。初期値は30秒です。

指定した郵便番号の住所を検索します。検索は非同期です。検索が成功か失敗すると、指定したコールバック関数を実行します。コールバック関数は次のとおりです。

fn (object[] response, number status)

検索が成功したか失敗したかは、引数の status で調べます。status は Postal.Lookup クラスの status と同じです。

検索結果は、引数の response から取得します。response は Postal.Lookup クラスの response と同じです。検索が失敗したときは、要素数が0の配列になります。

jQuery.lookup と同じです。

選択した要素の値を郵便番号とし、その郵便番号の住所を検索します。 検索が成功か失敗すると、指定したコールバック関数を実行します。 コールバック関数は jQuery.lookup と同じです。

選択した要素が input、select、textarea、button 要素のときは value 属性の値を郵便番号とします。 それ以外の要素のときは、テキストノードの値を郵便番号とします。

選択した要素の値を郵便番号とし、その郵便番号の住所を検索します。 検索が成功したときは、指定した要素の値を住所とします。 検索が失敗したときは何もしません。

選択した要素が input、select、textarea、button 要素のときは value 属性の値を郵便番号とします。 それ以外の要素のときは、テキストノードの値を郵便番号とします。

指定した要素が input、select、textarea、button 要素のときは value 属性の値を住所とします。 それ以外の要素のときは、テキストノードの値を住所とします。複数の住所が見つかったときは、その内のいずれか1つを採用します。

テキストボックスの入力形式を郵便番号に限定します。 テキストボックスは type 属性が text の input 要素です。

テキストボックスに郵便番号を入力すると、指定したコールバック関数を実行します。 コールバック関数は次のとおりです。

fn (string c)

入力した郵便番号は、引数の c から取得します。 このときの郵便番号は "123-4567" の書式からなる文字列です。

テキストボックスの入力形式を郵便番号に限定します。 テキストボックスは type 属性が text の input 要素です。

プラグインのオプションを指定します。必要に応じて次のオプションを指定できます。

number timeout

タイムアウト時間を秒単位で指定します。初期値は30秒です。

指定した住所の単語から郵便番号を検索します。検索は非同期です。検索が成功か失敗すると、指定したコールバック関数を実行します。コールバック関数は次のとおりです。

fn (object[] response, number status)

検索が成功したか失敗したかは、引数の status で調べます。status は Postal.Coder クラスの status と同じです。

検索結果は、引数の response から取得します。response は Postal.Coder クラスの response と同じです。検索が失敗したときは、要素数が0の配列になります。

jQuery.coder と同じです。

選択した要素の値を住所の単語とし、その住所の単語の郵便番号を検索します。 検索が成功か失敗すると、指定したコールバック関数を実行します。 コールバック関数は jQuery.coder と同じです。

選択した要素が input、select、textarea、button 要素のときは value 属性の値を住所の単語とします。 それ以外の要素のときは、テキストノードの値を住所の単語とします。

テキストボックスを拡張して、住所の入力を支援するようにします。いわゆるサジェストです。テキストボックスは type 属性が text の input 要素です。

テキストボックスに住所の単語を入力すると、その単語を含む住所を検索し、その結果を入力候補としてリスト表示します。入力候補を選択すると、その住所をテキストボックスに設定します。入力候補の選択は、マウスのほかにキーボードも使えます。

コールバック関数を指定すると、入力候補を選択したときのイベントをハンドリングできます。 コールバック関数は次のとおりです。

fn (object addr)

選択した入力候補は、引数の addr から取得します。 addr は Postal.Lookup クラスの response プロパティと同じ、住所のオブジェクトです。

リスト表示する入力候補の件数を指定できます。初期値は3件です。

コールバック関数とリスト表示する入力候補の件数を指定できます。

指定した処理の実行を後回しにします。10ms 経過すると、指定したコールバック関数を実行します。

jQuery.later と同じです。