はじめに

本ドキュメントは、駅すぱあと路線図の JavaScript ライブラリ rosen.js について網羅的に記述したリファレンス・マニュアルです。 対象読者として、JavaScript について基本的な知識を持った開発者を想定しています。

rosen.jsの推奨環境

rosen.jsの推奨環境は以下となります。

※Internet Explorerは非推奨となりますのでご注意ください。
※TLS1.0/1.1の環境ではご利用いただけません。TLS1.2の環境でご利用ください。

基礎知識

以下に、本ドキュメントを読むために必要な基礎知識を記述します。

Leaflet.js

rosen.js はオープンソースの地図ライブラリ Leaflet.js v1.6.0 を内包しています。 L.marker などの L から始まるメソッドは Leaflet.js に含まれるものです。 rosen.js のメソッドの中には Leaflet.js のオブジェクトを返すものがあり、それらのオブジェクトに対しては Leaflet.js がそのまま利用できます。 そのため、Leaflet.js の使用法を学習すると、本 API の応用範囲は大きく広がります。 Leaflet.js について詳しくは Leaflet.js 1.6.0 の API リファレンス を参照してください。

Promise

本 API では非同期処理を Promise を使って実現しています。 つまり非同期処理が入るメソッドは情報を戻り値で返すのではなく、戻り値に対して .then()、.catch() でコールバックを指定します。するとそのコールバックの引数として情報が入ってきます。 例えば、getStationByCode メソッドの使い方は下記のようになります：

// 正しくない例：
var station_code = 22671;
var station = rosen.getStationByCode(station_code);
console.log(station);        // stationに入っているオブジェクトは駅情報ではありません

// 正しい例：
var station_code = 22671;
rosen.getStationByCode(station_code).then(function (station) {
    console.log(station);    // stationに駅情報が入っています
});

本ドキュメントでメソッドの戻り値の欄に Promise object と書かれている場合は全て同様です。 Promiseについてより詳しくは、JavaScript Promiseの本やJavaScriptのPromiseオブジェクトについて調べた事などを参照してください。

サーバアクセスの可能性

と 書かれているメソッドは、本システムの API サーバに Ajax でアクセスする可能性があります。 rosen.js はAPIサーバから取得したデータを JavaScript の変数にキャッシュしますので、 同じ API を呼んでも 2 度目以降はサーバアクセスしない場合があります。

省略可能な引数

メソッドの説明において、options?のように「?」が付いている引数は省略可能です。