html5_reference_Course

WebAPI Document - リファレンス

経路表示パーツ

• 構築

書式	解説
expGuiCourse(container)	container の中に経路表示に必要な HTMLElement を生成します。 var resultApp = new expGuiCourse(document.getElementById("result"));

• 関数

書式	戻り値	解説
dispCourse()	なし	経路表示パーツを表示します
search(string [, 定数:運賃種別 [, listener ]])	なし	探索文字列で経路探索を行います パラメータにviaListを設定すれば経路探索 /search/course/extreme、from/toを設定すれば平均待ち時間探索 /search/course/plainでの探索となります
search(searchInterface [, listener ])	なし	探索オブジェクトで経路探索を行います
changeCourse(no [, listener ])	なし	指定した探索結果に変更します
getSerializeData()	string	表示されている経路のシリアライズデータを取得します
getSerializeDataAll()	string	全経路のシリアライズデータをカンマ区切りで取得します
getTeiki()	string	定期控除に利用できる文字列を取得します
getNikukanteikiIndex()	string	定期割り当て用経路が二区間定期の場合、その状態を表すindexを返します。
getVehicleIndex()	string	定期の車両の状態を表すindexを返します。
getLineObject(int)	object	二区間定期、もしくは、定期車両のindexを指定し、定期状態オブジェクトを取得します
getResult()	object	表示されている経路オブジェクトを取得します
getResultAll()	object	探索結果すべての経路オブジェクトを取得します
getResultString()	string	表示されている経路のJSONデータを取得します
getResultStringAll()	string	全経路のJSONデータを取得します
setResult(JSON)	なし	指定したJSONデータを経路に展開します
setSerializeData(string [, 定数:運賃種別 [, listener ]])	なし	シリアライズデータを経路に復元します
getDepartureDate()	string	表示されている経路の出発日時を取得します
getArrivalDate()	string	表示されている経路の到着日時を取得します
getPointList()	string	利用地点リストを取得します
getPointObject(int)	object	地点番号を指定し、地点オブジェクトを取得します
getLineList()	string	利用区間リストを取得します
getLineObject(int)	object	区間番号を指定し、区間オブジェクトを取得します
getResultCount()	int	表示された探索結果数を取得します
getPrice(定数:運賃種別)	int	金額を取得します
getFarePrice(定数:運賃種別)	int	運賃を取得します
getChargePrice(定数:運賃種別)	int	特急券等の特別料金を取得します
getTeikiPrice(定数:定期券種別)	int	定期代を取得します
checkBestCourse(定数:ソート種別)	boolean	表示された経路が最良であるかを返します
checkWithTeiki(定数:定期券種別)	boolean	表示された経路で定期控除が行われているかを返します
createSearchInterface()	object	探索オブジェクトを作成します
courseEdit(string [, listener ])	なし	表示されている経路の入れ替えを行います
menu(string, listener [, mask])	object	メニューオブジェクトを作成します
addLineMenu(menu)	なし	路線メニューを追加します
addPointMenu(menu)	なし	駅メニューを追加します
setConfigure(name, value)	なし	環境設定変更を行います
bind(event, listener)	なし	イベントを設定します
unbind(event)	なし	イベントを解除します

• searchInterface

setViaList()を指定すれば経路探索 /search/course/extreme、setFrom()/setTo()を指定すれば平均待ち時間探索 /search/course/plainでの探索となります。

経路探索 /search/course/extreme専用関数

書式	解説
setViaList(string)	駅コードや座標などのリスト設定
getViaList()	viaList設定値取得
setFixedRailList(string)	固定路線の名称リスト設定
getFixedRailList()	fixedRailList設定値取得
setFixedRailDirectionList(string)	固定路線の方向リスト設定
getFixedRailDirectionList()	fixedRailDirectionList設定値取得
setTime(int)	探索時刻(HHMM)設定
getTime()	time設定値取得
setSearchType(string)	探索種別設定
getSearchType()	searchType設定値取得
setSort(string)	ソート種別設定
getSort()	sort設定値取得
setAnswerCount(int)	最大回答数設定
getAnswerCount()	answerCount設定値取得
setSearchCount(int)	最大探索数設定
getSearchCount()	searchCount設定値取得
setConditionDetail(string)	詳細探索条件データ設定
getConditionDetail()	conditionDetail設定値取得
setCorporationBind(string)	固定会社名設定
getCorporationBind()	corporationBind設定値取得
setInterruptCorporationList(string)	不通会社リスト設定
getInterruptCorporationList()	interruptCorporationList設定値取得
setInterruptRailList(string)	不通路線リスト設定
getInterruptRailList()	interruptRailList設定値取得
setResultDetail(string)	結果に詳細情報の付加設定
getResultDetail()	resultDetail設定値取得
setAssignRoute(string)	定期割り当て用経路文字列設定
getAssignRoute()	assignRoute設定値取得
setAssignDetailRoute(string)	定期割り当て用詳細経路文字列設定
getAssignDetailRoute()	assignDetailRoute設定値取得
setAssignTeikiSerializeData(string)	定期経路シリアライズデータ設定
getAssignTeikiSerializeData()	assignTeikiSerializeData設定値取得
setOffpeakTeikiMode(string)	オフピーク定期券利用時の計算モード設定
getOffpeakTeikiMode()	offpeakTeikiMode設定値取得
setAssignNikukanteikiIndex(string)	定期割り当て用二区間定期の設定
getAssignNikukanteikiIndex()	assignNikukanteikiIndex設定値取得
setCoupon(string)	割り当て回数券詳細名称設定
getCoupon()	coupon設定値取得
setPriceType(string)	運賃種別設定
getPriceType()	priceType設定値取得

平均待ち時間探索 /search/course/plain専用関数

書式	解説
setFrom(string)	駅コードや座標などの出発駅設定
getFrom()	from設定値取得
setTo(string)	駅コードや座標などの到着駅設定
getTo()	to設定値取得
setVia(string)	駅コードや座標などの経由駅設定
getVia()	via設定値取得
setPlane(string)	飛行機利用可否設定
getPlane()	plane設定値取得
setShinkansen(string)	新幹線利用可否設定
getShinkansen()	shinkansen設定値取得
setLimitedExpress(string)	特急利用可否設定
getLimitedExpress()	limitedExpress設定値取得
setBus(string)	バス利用可否設定
getBus()	bus設定値取得

経路探索 /search/course/extreme、 平均待ち時間探索 /search/course/plainの共通関数

書式	解説
setDate(int)	探索日付(YYYYMMDD)設定
getDate()	Date設定値取得

• 地点オブジェクト

メンバー名	解説
code	駅コード（Read Only）
name	名称（Read Only）
yomi	読みかな（Read Only）
type	交通種別（Read Only）
type_detail	より詳細な交通種別（Read Only）
lati	緯度 (度.分.秒.100分の1秒)（Read Only）
lati_d	緯度 (度)（Read Only）
longi	経度 (度.分.秒.100分の1秒)（Read Only）
longi_d	経度 (度)（Read Only）
gcs	測地系（Read Only）
kenCode	都道府県コード（Read Only）

※地点オブジェクトはgetPointObjectの戻り値でのみ定義されます。

• 区間オブジェクト

メンバー名	解説
name	名称（Read Only）
abbreviation	略称（Read Only）
type	交通種別（Read Only）
type_detail	より詳細な交通種別（Read Only）
number	番号(号、便など)を表す要素（Read Only）
color	色を表す要素（Read Only）
departureTime	出発時刻（Read Only）
arrivalTime	到着時刻（Read Only）
corporation	運行会社（Read Only）
track	軌道種別（Read Only）

※区間オブジェクトはgetLineObjectの戻り値でのみ定義されます。

• 定期状態オブジェクト

メンバー名	解説
name	名称（Read Only）
type	種別（Read Only）
kind	状態の種類（Read Only）
comment	コメント文字列（Read Only）

※定期状態オブジェクトはgetPassStatusObjectの戻り値でのみ定義されます。

• 環境設定

setConfigure関数で指定できる値です。

パラメータ名	内容	デフォルト値
PriceChange	座席種別を変更できるかどうかを設定します	true (有効)
PriceChangeRefresh	座席種別変更時にリクエストするかどうかを設定します	false (無効)
AssignDia	前後のダイヤ割り当てを利用するかどうか設定します	false (無効)
CourseList	経路一覧を表示するかどうかを設定します	false (無効)
window	経路をポップアップ表示するかどうかを設定します	false (無効)
from	画面に表示する出発地を任意の値に設定します	setViaList()で指定した出発地の値
to	画面に表示する到着地を任意の値に設定します	setViaList()で指定した到着地の値

• イベント

bind関数、unbind関数の第一引数に指定できる値です。

書式	解説
change	経路の切り替えが行われた際にコールされます
close	経路を閉じた際にコールされます
select	経路を確定した際にコールされます

全パーツ共通の環境設定

• 環境設定

setConfigure関数で指定できる値です。

パラメータ名	引数	説明
apiURL	文字列(URL)	APIのURLを指定します
agent	定数:端末種別	指定した端末種別向けのデザインに変更します ※端末種別の指定は指定した端末以外を制限するものではありません。
ssl	true:https通信/false:http通信	SSL暗号化通信のオンオフを切り替えます 例: setConfigure("ssl", true)
key	アクセスキー	アクセスキーを、URL埋め込みではなくメソッド経由で指定します