WebAPI Document - GUIソリューション - リファレンス

定数

識別子説明
TYPE_TRAIN 列車
TYPE_PLANE 飛行機
TYPE_SHIP
TYPE_BUS バス
TYPE_WALK 徒歩
TYPE_STRANGE 特殊
TYPE_TRAIN_LIMITEDEXPRESS 有料特急
TYPE_TRAIN_SHINKANSEN 新幹線
TYPE_TRAIN_SLEEPERTRAIN 寝台列車
TYPE_TRAIN_LINER 有料普通列車
TYPE_BUS_LOCAL 路線バス
TYPE_BUS_CONNECTION 連絡バス
TYPE_BUS_HIGHWAY 高速バス
TYPE_BUS_MIDNIGHT 深夜急行バス
識別子説明
SEARCHTYPE_DEPARTURE 発時刻探索
SEARCHTYPE_ARRIVAL 着時刻探索
SEARCHTYPE_FIRSTTRAIN 始発探索
SEARCHTYPE_LASTTRAIN 終電探索
SEARCHTYPE_PLAIN 平均待ち時間探索
識別子説明
SORT_EKISPERT 駅すぱあと探索順
SORT_PRICE 料金順
SORT_TIME 時間順
SORT_TEIKI 定期券の料金順
SORT_TRANSFER 乗換回数順
SORT_CO2 CO2排出量順
SORT_TEIKI1 1ヶ月定期券の料金順
SORT_TEIKI3 3ヶ月定期券の料金順
SORT_TEIKI6 6ヶ月定期券の料金順
識別子説明
PRICE_ONEWAY 片道
PRICE_ROUND 往復
PRICE_TEIKI 定期券
識別子説明
DIRECTION_UP 上り
DIRECTION_DOWN 下り
DIRECTION_NONE 設定なし
DIRECTION_BOTH 両方向で利用可能※
DIRECTION_DEFINE 定義された方向のみ利用可能※

※回数券情報パーツで利用します

識別子説明
TEIKI1 1ヵ月
TEIKI3 3ヵ月
TEIKI6 6ヵ月
識別子説明
TYPE_TEIKI1 1ヶ月定期
TYPE_TEIKI3 3ヶ月定期
TYPE_TEIKI6 6ヶ月定期
TYPE_FARE 運賃

※分割計算パーツで利用します

識別子説明
CONDITON_ANSWERCOUNT 最大回答数
CONDITON_SORTTYPE ソート種別
CONDITON_PRICETYPE 運賃種別
CONDITON_PLANE 飛行機
CONDITON_SHINKANSEN 新幹線
CONDITON_SHINKANSENNOZOMI 新幹線のぞみ
CONDITON_SLEEPERTRAIN 寝台列車
CONDITON_LIMITEDEXPRESS 有料特急
CONDITON_HIGHWAYBUS 高速バス
CONDITON_CONNECTIONBUS 連絡バス
CONDITON_LOCALBUS 路線バス
CONDITON_SHIP
CONDITON_LINER 有料普通列車
CONDITON_WALK 駅間徒歩
CONDITON_MIDNIGHTBUS 深夜急行バス
CONDITON_SURCHARGEKIND 特急料金種別希望初期値
CONDITON_TEIKIKIND 定期種別初期値
CONDITON_JRSEASONALRATE JR季節料金
CONDITON_STUDENTDISCOUNT 学割乗車券
CONDITON_INCLUDEINSURANCE 航空保険特別料金
CONDITON_TICKETSYSTEMTYPE 乗車券計算のシステム
CONDITON_PREFERREDTICKETORDER 優先する乗車券の順序
CONDITON_NIKUKANTEIKI 2区間定期(だぶるーと,JR2区間定期)の利用
CONDITON_USEJR JR路線
CONDITON_TRANSFER 乗換え
CONDITON_EXPRESSSTARTINGSTATION 特急始発駅
CONDITON_WAITAVERAGETIME 出発駅乗車待ち平均時間の利用
CONDITON_LOCALBUSONLY 路線バスのみ探索
CONDITON_TRANSFERTIME 乗換え時間
識別子説明
TYPE_RAIL 乗り入れ路線
TYPE_NEARRAIL 最寄路線
TYPE_EXIT 福祉設備
TYPE_WELFARE 出口
識別子説明
TDFK_HOKKAIDO 北海道
TDFK_AOMORI 青森県
TDFK_IWATE 岩手県
TDFK_MIYAGI 宮城県
TDFK_AKITA 秋田県
TDFK_YAMAGATA 山形県
TDFK_FUKUSHIMA 福島県
TDFK_IBARAKI 茨城県
TDFK_TOCHIGI 栃木県
TDFK_GUNMA 群馬県
TDFK_SAITAMA 埼玉県
TDFK_CHIBA 千葉県
TDFK_TOKYO 東京都
TDFK_KANAGAWA 神奈川県
TDFK_NIIGATA 新潟県
TDFK_TOYAMA 富山県
TDFK_ISHIKAWA 石川県
TDFK_FUKUI 福井県
TDFK_YAMANASHI 山梨県
TDFK_NAGANO 長野県
TDFK_GIFU 岐阜県
TDFK_SHIZUOKA 静岡県
TDFK_AICHI 愛知県
TDFK_MIE 三重県
TDFK_SHIGA 滋賀県
TDFK_KYOTO 京都府
TDFK_OSAKA 大阪府
TDFK_HYOGO 兵庫県
TDFK_NARA 奈良県
TDFK_WAKAYAMA 和歌山県
TDFK_TOTTORI 鳥取県
TDFK_SHIMANE 島根県
TDFK_OKAYAMA 岡山県
TDFK_HIROSHIMA 広島県
TDFK_YAMAGUCHI 山口県
TDFK_TOKUSHIMA 徳島県
TDFK_KAGAWA 香川県
TDFK_EHIME 愛媛県
TDFK_KOCHI 高知県
TDFK_FUKUOKA 福岡県
TDFK_SAGA 佐賀県
TDFK_NAGASAKI 長崎県
TDFK_KUMAMOTO 熊本県
TDFK_OITA 大分県
TDFK_MIYAZAKI 宮崎県
TDFK_KAGOSHIMA 鹿児島県
TDFK_OKINAWA 沖縄県

日付入力パーツ

書式解説
expGuiDateTime(container) container の中に日付入力に必要な HTMLElement を生成します。
var dateTimeApp = new expGuiDateTime(document.getElementById("dateTime"));
書式戻り値解説
dispDateTime([定数:探索種別]) なし 日付入力パーツを表示します
checkDate() boolean 入力された日付が正しいかどうかをチェックします
getDate() string 入力された値「yyyymmdd」を取得します
getTime() string 入力された値「hh24mi」を取得します
getSearchType() 定数:探索種別 選択された探索種別を取得します
setSearchType(定数:探索種別) なし 指定した探索種別に変更します
setDate(yyyymmdd) なし 指定した日付に変更します
setTime(hh24mi) なし 指定した時間に変更します
openCalendar() なし カレンダーを開きます
closeCalendar() なし カレンダーを閉じます
setConfigure(name, value) なし 環境設定変更を行います

駅名入力パーツ

書式解説
expGuiStation(container) container の中に駅名入力に必要な HTMLElement を生成します。
var stationApp = new expGuiStation(document.getElementById("station"));
書式戻り値解説
dispStation() なし 駅名入力パーツを表示します
getStation() string 入力中の内容を取得します
setStation(name) なし 駅名を指定します
getStationList() string 駅の候補をカンマ区切りで取得します
getStationName() string 選択された駅の駅名を取得します
getStationCode() int 選択された駅の駅コードを取得します
getPointObject(name) object 指定した駅の地点情報を取得します
closeStationList() なし 駅の候補を閉じます
checkStationList() boolean 駅の候補の表示状態を取得します
setConfigure(name, value) なし 環境設定変更を行います
bind(event, listener) なし イベントを設定します
unbind(event) なし イベントを解除します
メンバー名解説
code 駅コード(Read Only)
name 名称(Read Only)
yomi 読みかな(Read Only)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)
kenCode 都道府県コード(Read Only)

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

書式設定値解説
type 定数:交通種別 表示される交通種別の絞り込みを行います
prefectureCode 定数:都道府県コード 表示される都道府県の指定を行います
maxStation int 一度に表示される候補の件数を指定します
書式解説
open 候補が表示された際にコールされます
close 候補が閉じられた際にコールされます
change 入力値が変更された際にコールされます
enter エンターキーが押された際にコールされます
focus フォーカスが合った際にコールされます
blur フォーカスが外れた際にコールされます

探索条件パーツ

書式解説
expGuiCondition(container) container の中に探索条件に必要な HTMLElement を生成します。
var conditonApp = new expGuiCondition(document.getElementById("condition"));
書式戻り値解説
dispCondition() なし 探索条件パーツを表示します
dispConditionSimple() なし 簡易的な探索条件パーツを表示します
getPriceType() 定数:運賃種別 設定した運賃種別を取得します
getConditionDetail() string 設定した詳細探索条件データを取得します
getAnswerCount() int 設定した運賃種別を取得します
getSortType() 定数:ソート種別 設定したソート種別を取得します
setCondition(定数:探索条件, value) なし 指定した探索条件に変更します
setCondition(answerCount, 定数:ソート種別, 定数:運賃種別, condition) なし 指定した探索条件に変更します
resetCondition() なし 探索条件を初期値に戻します
setConfigure(name, value) なし 環境設定変更を行います
書式引数説明
CONDITON_ANSWERCOUNT 最大20 (デフォルトは5) 最大回答数
CONDITON_SORTTYPE 定数:ソート種別 (デフォルトは駅すぱあと探索順) ソート種別
CONDITON_PRICETYPE 定数:運賃種別 (デフォルトは片道) 運賃種別
CONDITON_PLANE 気軽に利用:light, 普通に利用:normal, 極力利用しない:bit, 利用しない:never (デフォルトはnormal) 飛行機
CONDITON_SHINKANSEN 利用する:normal, 利用しない:never (デフォルトはnormal) 新幹線
CONDITON_SHINKANSENNOZOMI 利用する:normal, 利用しない:never (デフォルトはnormal) 新幹線のぞみ
CONDITON_SLEEPERTRAIN 極力利用する:possible, 普通に利用:normal, 利用しない:never (デフォルトはnever) 寝台列車
CONDITON_LIMITEDEXPRESS 利用する:normal, 利用しない:never (デフォルトはnormal) 有料特急
CONDITON_HIGHWAYBUS 気軽に利用light, 普通に利用:normal, 極力利用しない:bit, 利用しない:never (デフォルトはnormal) 高速バス
CONDITON_CONNECTIONBUS 気軽に利用:light, 普通に利用:normal, 極力利用しない:bit, 利用しない:never (デフォルトはnormal) 連絡バス
CONDITON_LOCALBUS 利用する:normal, 利用しない:never (デフォルトはnormal) 路線バス
CONDITON_SHIP 気軽に利用:light, 普通に利用:normal, 極力利用しない:bit, 利用しない:never (デフォルトはnormal)
CONDITON_LINER 探索種別が平均待ち時間探索の場合は無効です。利用する:normal, 利用しない:never (デフォルトはnormal) 有料普通列車
CONDITON_WALK 探索種別が平均待ち時間探索の場合にのみ有効です。気にならない:normal, 少し気になる:little, 利用しない:never (デフォルトはnormal) 駅間徒歩
CONDITON_MIDNIGHTBUS 探索種別が平均待ち時間探索の場合は無効です。利用する:normal, 利用しない:never (デフォルトはnever) 深夜急行バス
CONDITON_SURCHARGEKIND 自由席:free, 指定席:reserved, グリーン:green (デフォルトはfree) 特急料金種別希望初期値
CONDITON_TEIKIKIND 通勤:bussiness, 学割 (高校):highSchool, 学割:university (デフォルトはbussiness) 定期種別初期値
CONDITON_JRSEASONALRATE 繁忙期・閑散期の季節料金を考慮する:true, 無視する:false (デフォルトはtrue) JR季節料金
CONDITON_STUDENTDISCOUNT 計算する:true, 計算しない:false (デフォルトはfalse) 学割乗車券
CONDITON_INCLUDEINSURANCE 運賃に含む:true, 運賃に含まない:false (デフォルトはtrue) 航空保険特別料金
CONDITON_TICKETSYSTEMTYPE 普通乗車券のみ計算する:normal, ICカード乗車券も計算する:ic (デフォルトはnormal) 乗車券計算のシステム
CONDITON_PREFERREDTICKETORDER 乗車券計算のシステムに"ic"を設定した場合のみ有効。 指定なし:none, 普通乗車券を優先する:normal, ICカード乗車券を優先する:ic, 安い乗車券を優先する:cheap (デフォルトはnone) 優先する乗車券の順序
CONDITON_NIKUKANTEIKI 利用 true:利用する false:利用しない(省略可 デフォルトはデフォルト値 false:利用しない) 2区間定期(だぶるーと,JR2区間定期)の利用
CONDITON_USEJR 探索種別が平均待ち時間探索の場合にのみ有効です。気軽に利用light, 普通に利用:normal, 極力利用しない:bit (デフォルトはnormal) JR路線
CONDITON_TRANSFER 探索種別が平均待ち時間探索の場合にのみ有効です。気にならない:normal, 少し気になる:little, 利用しない:never (デフォルトはnormal) 乗換え
CONDITON_EXPRESSSTARTINGSTATION 探索種別が平均待ち時間探索の場合にのみ有効です。なるべく利用:possible, 普通に利用:normal (デフォルトはnormal) 特急始発駅
CONDITON_WAITAVERAGETIME 探索種別が平均待ち時間探索の場合にのみ有効です。平均待ち時間を利用する:true, 待ち時間なし:false (デフォルトはtrue) 出発駅乗車待ち平均時間の利用
CONDITON_LOCALBUSONLY 探索種別が平均待ち時間探索の場合にのみ有効です。する:true, しない:false (デフォルトはfalse) 路線バスのみ探索
CONDITON_TRANSFERTIME 探索種別が平均待ち時間探索の場合は無効です。駅すぱあとの既定値:normal, 既定値より少し余裕をみる:moreMargin, 既定値より余裕をみる:mostMargin, 既定値より短い時間にする:lessMargin (デフォルトはnormal) 乗換え時間
書式引数説明
CONDITON_ANSWERCOUNT visible:表示/hidden:非表示 最大回答数
CONDITON_SORTTYPE visible:表示/hidden:非表示 ソート種別
CONDITON_PRICETYPE visible:表示/hidden:非表示 運賃種別
CONDITON_PLANE visible:表示/hidden:非表示 飛行機
CONDITON_SHINKANSEN visible:表示/hidden:非表示 新幹線
CONDITON_SHINKANSENNOZOMI visible:表示/hidden:非表示 新幹線のぞみ
CONDITON_SLEEPERTRAIN visible:表示/hidden:非表示 寝台列車
CONDITON_LIMITEDEXPRESS visible:表示/hidden:非表示 有料特急
CONDITON_HIGHWAYBUS visible:表示/hidden:非表示 高速バス
CONDITON_CONNECTIONBUS visible:表示/hidden:非表示 連絡バス
CONDITON_LOCALBUS visible:表示/hidden:非表示 路線バス
CONDITON_SHIP visible:表示/hidden:非表示
CONDITON_LINER visible:表示/hidden:非表示 有料普通列車
CONDITON_WALK visible:表示/hidden:非表示 駅間徒歩
CONDITON_MIDNIGHTBUS visible:表示/hidden:非表示 深夜急行バス
CONDITON_SURCHARGEKIND visible:表示/hidden:非表示 特急料金種別希望初期値
CONDITON_TEIKIKIND visible:表示/hidden:非表示 定期種別初期値
CONDITON_JRSEASONALRATE visible:表示/hidden:非表示 JR季節料金
CONDITON_STUDENTDISCOUNT visible:表示/hidden:非表示 学割乗車券
CONDITON_INCLUDEINSURANCE visible:表示/hidden:非表示 航空保険特別料金
CONDITON_TICKETSYSTEMTYPE visible:表示/hidden:非表示 乗車券計算のシステム
CONDITON_PREFERREDTICKETORDER visible:表示/hidden:非表示 優先する乗車券の順序
CONDITON_NIKUKANTEIKI visible:表示/hidden:非表示 2区間定期(だぶるーと,JR2区間定期)の利用
CONDITON_USEJR visible:表示/hidden:非表示 JR路線
CONDITON_TRANSFER visible:表示/hidden:非表示 乗換え
CONDITON_EXPRESSSTARTINGSTATION visible:表示/hidden:非表示 特急始発駅
CONDITON_WAITAVERAGETIME visible:表示/hidden:非表示 出発駅乗車待ち平均時間の利用
CONDITON_LOCALBUSONLY visible:表示/hidden:非表示 路線バスのみ探索
CONDITON_TRANSFERTIME visible:表示/hidden:非表示 乗換え時間

ランドマークパーツ

書式解説
expGuiLandmark() ランドマークオブジェクトを生成します。
var landmark = new expGuiLandmark();
書式戻り値解説
createLandmark(landmarkInterface [, listener ]) なし ランドマーク情報を作成します
createLandmarkInterface(name) object ランドマーク名を指定し、ランドマーク用地点情報インターフェースを作成します
createLandmarkStationInterface(stationName) object 駅名を指定し、ランドマーク用駅情報インターフェースを作成します
getSerializeData() string ランドマークのシリアライズデータを取得します
setConfigure(name, value) なし 環境設定変更を行います
書式解説
setName(string) 名称設定
getName() 名称設定値取得
addStation(stationInterface) 駅情報オブジェクトを追加します
removeStation(stationName) 駅情報オブジェクトを削除します

※地点情報インターフェースはcreateLandmarkInterfaceにて生成してください。

書式解説
getStation() 駅設定値取得
setTime(int) 所要時間設定
getTime() 所要時間設定値取得
setFare(int) 運賃設定
getFare() 運賃設定値取得
setTraffic(string) 移動手段設定
getTraffic() 移動手段設定値取得
setDistance(int) 距離設定
getDistance() 距離設定値取得
setTeiki1(int) 1ヵ月定期代設定
getTeiki1() 1ヵ月定期代設定値取得
setTeiki3(int) 3ヵ月定期代設定
getTeiki3() 3ヵ月定期代設定値取得
setTeiki6(int) 6ヵ月定期代設定
getTeiki6() 6ヵ月定期代設定値取得

※駅情報インターフェースはcreateLandmarkStationInterfaceにて生成してください。

回数券情報パーツ

書式解説
expGuiCoupon() 回数券情報オブジェクトを生成します。
var coupon = new expGuiCoupon();
書式戻り値解説
searchCoupon([couponName [, listener ]]) なし 駅すぱあとの保持する回数券の一覧を検索します
getCouponList() string 回数券の一覧をカンマ区切りで取得します
searchCouponDetail(couponName [, listener ]) string 回数券の名称を指定し、回数券の詳細情報を検索します
getCouponDetailList() string 回数券の詳細情報一覧をカンマ区切りで取得します
getCouponObject(couponDetaiName) object 回数券の詳細名称を指定し、回数券オブジェクトを取得します
searchCourseCoupon(serializeData [, listener ]) string 探索結果を利用して回数券を検索します
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
name 名称(Read Only)
count 枚数などの数(Read Only)
validPeriod 有効期間(Read Only)
direction 回数券の設定区間の方向(Read Only)
price 合計金額(Read Only)

※回数券オブジェクトはgetCouponObjectの戻り値でのみ定義されます。

経路表示パーツ

書式解説
expGuiCourse(container) container の中に経路表示に必要な HTMLElement を生成します。
var resultApp = new expGuiCourse(document.getElementById("result"));
書式戻り値解説
dispCourse() なし 経路表示パーツを表示します
search(string [, 定数:運賃種別 [, listener ]]) なし 探索文字列で経路探索を行います
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) なし 環境設定変更を行います
書式解説
setViaList(string) 駅コードや座標などのリスト設定
getViaList() ViaList設定値取得
setFixedRailList(string) 固定路線の名称リスト設定
getFixedRailList() FixedRailList設定値取得
setFixedRailDirectionList(string) 固定路線の方向リスト設定
getFixedRailDirectionList() FixedRailDirectionList設定値取得
setDate(int) 探索日付(YYYYMMDD)設定
getDate() Date設定値取得
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設定値取得
setAssignNikukanteikiIndex(string) 定期割り当て用二区間定期の設定
getAssignNikukanteikiIndex() assignNikukanteikiIndex設定値取得
setCoupon(string) 割り当て回数券詳細名称設定
getCoupon() Coupon設定値取得
setPriceType(string) 運賃種別設定
getPriceType() PriceType設定値取得
メンバー名解説
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の戻り値でのみ定義されます。

パラメータ名内容デフォルト値
PriceChange 座席種別を変更できるかどうかを設定します true
(有効)
PriceChangeRefresh 座席種別変更時にリクエストするかどうかを設定します false
(無効)
AssignDia 前後のダイヤ割り当てを利用するかどうか設定します false
(無効)
CourseList 経路一覧を表示するかどうかを設定します false
(無効)
window 経路をポップアップ表示するかどうかを設定します false
(無効)
書式解説
change 経路の切り替えが行われた際にコールされます
close 経路を閉じた際にコールされます
select 経路を確定した際にコールされます

駅情報パーツ

書式解説
expGuiStationInfo() 駅情報オブジェクトを生成します。
var stationInfo = new expGuiStationInfo();
書式戻り値解説
searchStation(lati, longi, gcs, [, radius [, listener ]]) なし 駅を指定した座標(緯度経度)と半径(m)で検索します
getStation(stationName [, listener ]) なし 駅名で駅情報を取得します
getStationOldName(oldName [, listener ]) なし 旧駅名で駅情報を取得します
getAllStation([ listener ]) なし 名称を指定せずに駅情報を取得します
getStationList() string 駅名一覧をカンマ区切りで取得します
getPointObject(stationName) object 停車駅を指定し、地点オブジェクトを取得します
getStationInfo(name [, listener ]) なし 指定した駅の付加情報を取得します
getInformationList(定数:情報種別) string 付加情報を取得します
getInformationObject(name, 定数:情報種別) object 付加情報オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
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)
type 交通種別(Read Only)
color 色を表す要素(Read Only)
corporation 運行会社名(Read Only)
comment コメント文字列(Read Only)

※付加情報オブジェクトはgetInformationObjectの戻り値でのみ定義されます。

パラメータ名内容
corporationBind 対象とする会社名を固定します
type 対象とする交通種別の絞り込みを行います
prefectureCode 表示される都道府県の指定を行います

路線情報パーツ

書式解説
expGuiRail() 路線情報オブジェクトを生成します。
var rail = new expGuiRail();
書式戻り値解説
searchCorporation([corporationName [, listener ]]) なし 会社名を検索します
getCorporationList() string 会社名一覧をカンマ区切りで取得します
searchRail(corporationName [, listener ]) なし 会社名で路線名を検索します
getRailList() string 路線名一覧をカンマ区切りで取得します
searchStation(railName, 定数:方向 [, listener ]) なし 路線名と方向で停車駅を検索します
getStationList() string 停車駅一覧をカンマ区切りで取得します
getPointObject(name) object 停車駅を指定し、地点オブジェクトを取得します
getDirection() 定数:方向 検索済みの停車駅一覧の方向を取得します
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
code 駅コード(Read Only)
name 名称(Read Only)
yomi 読みかな(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)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)
onRoute 経路フラグ(Read Only)
onRouteEdge 折り返し経路フラグ(Read Only)
getOff 降車可能フラグ。true:可能、false:不可能(Read Only)

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

パラメータ名内容
type 表示される交通種別の絞り込みを行います
prefectureCode 表示される都道府県の指定を行います

駅時刻表パーツ

書式解説
expGuiStationTimeTable(container) container の中に駅時刻表に必要な HTMLElement を生成します。
var stationTimetable = new expGuiStationTimeTable(document.getElementById("stationTimetable"));
書式戻り値解説
dispStationTimetable(stationName, code [, date [, listener ]] ) なし 駅名から時刻表を表示します
dispCourseTimetable(serializeData, sectionIndex [, listener ]) なし 探索結果を利用して時刻表を表示します
searchLine(stationName [, date [, listener ]]) なし 駅名から路線を検索します
getLineObjectList() Array 区間オブジェクトリストを取得します
getTimeTableObject(lineCode) object 指定した時刻表オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
bind(event, listener) なし イベントを設定します
unbind(event) なし イベントを解除します
メンバー名解説
code 時刻表を特定する一意のコード(Read Only)
name 名称(Read Only)
direction 略称(Read Only)

※区間オブジェクトはgetLineObjectListの戻り値でのみ定義されます。 ※上記以外は'undefined'になります。

メンバー名解説
hour 時を表す要素(Read Only)
minute 分を表す要素(Read Only)
lineCode 時刻表を特定する一意のコード(Read Only)
lineKind 列車等の種別情報を表す要素(Read Only)
lineName 列車等の名称を表す要素(Read Only)
lineDestination 列車等の行き先情報を表す要素(Read Only)

※時刻表オブジェクトはgetTimeTableObjectの戻り値でのみ定義されます。

書式解説
click 時刻表内の特定の列車をクリックした際にコールされます

区間時刻表パーツ

書式解説
expGuiSectionTimeTable(container) container の中に区間時刻表に必要な HTMLElement を生成します。
var sectionTimeTable = new expGuiSectionTimeTable(document.getElementById("sectionTimetable"));
書式戻り値解説
dispPlaneTimetable(lineName, 定数:方向 [, date [, listener ]] ) なし 路線名と方向から航空時刻表を表示します
dispBusTimetable(from, to [, date [, listener ]] ) なし バス停の出発地と目的地を指定し、バスの区間時刻表を表示します
dispShipTimetable(lineName, 定数:方向 [, date [, listener ]] ) なし 路線名と方向から海路の時刻表を表示します
dispRailTimetable(serializeData, sectionIndex [, listener ] ) なし 探索結果を利用して区間時刻表を表示します
getLineObject(code) object 区間インデックスを指定し、区間オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
bind(event, listener) なし イベントを設定します
unbind(event) なし イベントを解除します
メンバー名解説
name 名称(Read Only)
abbreviation 略称(Read Only)
type 交通種別(Read Only)
number 番号(号、便など)を表す要素(Read Only)
color 色を表す要素(Read Only)
departureTime 出発時刻(Read Only)
arrivalTime 到着時刻(Read Only)
from 出発地の名称(Read Only)
to 到着地の名称(Read Only)

※区間オブジェクトはgetLineObjectの戻り値でのみ定義されます。 ※上記以外は'undefined'になります。

書式解説
click 時刻表内の特定の列車をクリックした際にコールされます

列車時刻表パーツ

書式解説
expGuiTrainTimeTable(container) container の中に定期払戻計算に必要な HTMLElement を生成します。
var trainTimeTable = new expGuiTrainTimeTable(document.getElementById("trainTimeTable"));
書式戻り値解説
dispStationTrainTimetable(code, [, listener ] ) なし 列車等を特定するコードを指定して時刻表を表示します
dispCourseTrainTimetable(code, [, listener ] ) なし 列車等を特定するコードを指定して時刻表を表示します
getPointObject(time) object 時間を指定し、地点オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
bind(event, listener) なし イベントを設定します
unbind(event) なし イベントを解除します
メンバー名解説
name 名称(Read Only)
code 駅コード(Read Only)
getOff 降車可能フラグ。true:可能、false:不可能(Read Only)
getOn 乗車可能フラグ。true:可能、false:不可能(Read Only)
arrivalTime 到着時刻(Read Only)
departureTime 出発時刻(Read Only)

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

書式解説
click 時刻表内の特定の列車をクリックした際にコールされます

定期払戻計算パーツ

書式解説
expGuiRepayment(container) container の中に定期払戻計算に必要な HTMLElement を生成します。
var repayment = new expGuiRepayment(document.getElementById("repayment"));
書式戻り値解説
dispRepayment(repaymentInterface, [, listener ] ) なし repaymentInterfaceオブジェクトを指定し、払い戻し計算金額を表示します
getRepayPrice() int 払い戻し金額を取得します
getRepayCount() int 払い戻し計算区間数を取得します
getRepayObject(int) object 区間番号を指定し、払い戻し計算オブジェクトを取得します
getPointObject(name) object 停車駅を指定し、地点オブジェクトを取得します
createRepaymentInterface() object RepaymentInterfaceオブジェクトを作成します
setConfigure(name, value) なし 環境設定変更を行います
bind(event, listener) なし イベントを設定します
unbind(event) なし イベントを解除します
書式解説
setSerializeData(serializeData) 探索結果のシリアライズデータを指定
getSerializeData() serializeData設定値取得
setStartDate(int) 定期利用開始日(YYYYMMDD)設定
getStartDate() 定期利用開始日設定値取得
setBuyDate(int) 定期購入日(YYYYMMDD)設定
getBuyDate() 定期購入日設定値取得
setRepaymentDate(int) 払い戻し日(YYYYMMDD)設定
getRepaymentDate() 払い戻し日設定値取得
setValidityPeriod(定数:定期券種別) 定期券有効期間の設定
getValidityPeriod() 払い戻し日設定値取得
setChangeSection(boolean) 払い戻しの際、区間変更計算式適用の設定
getChangeSection() 区間変更計算式適用の設定値取得
メンバー名解説
payPrice 購入金額(Read Only)
usedPrice 使用済金額(Read Only)
feePrice 手数料(Read Only)
repayPrice 払戻金額(Read Only)
validityPeriod 有効期間(Read Only)
state 定期の状態(Read Only)
from 出発地の名称(Read Only)
to 到着地の名称(Read Only)
メンバー名解説
code 駅コード(Read Only)
name 名称(Read Only)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)
kenCode 都道府県コード(Read Only)
書式解説
change 区間や計算の有無を変更した際にコールされます

分割計算パーツ

書式解説
expGuiDivided() 分割計算オブジェクトを生成します。
var divided = new expGuiDivided();
書式戻り値解説
searchTeikiDivided(string [, listener ]) なし シリアライズデータを指定し、定期代の分割計算金額を取得します
searchFareDivided(string [, listener ]) なし シリアライズデータを指定し、運賃の分割計算金額を取得します
getPrice(定数:金額種別) int 分割計算金額を取得します
getDividedCount() int 分割計算区間数を取得します
getDividedObject(int) object 区間番号を指定し、分割計算金額オブジェクトを取得します
getPointObject(name) object 停車駅を指定し、地点オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
type 金額種別(Read Only)
price 金額を表す要素(Read Only)
from 出発地の名称(Read Only)
to 到着地の名称(Read Only)
メンバー名解説
code 駅コード(Read Only)
name 名称(Read Only)
yomi 読みかな(Read Only)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)
kenCode 都道府県コード(Read Only)

範囲探索パーツ

書式解説
expGuiRange() 路線情報オブジェクトを生成します。
var stationRange = new expGuiRange();
書式戻り値解説
searchStation(stationName, upperLimit [, listener ]) なし 駅と移動にかかる上限値(単位:分)を指定し、範囲探索を行います
getStationList() string 駅一覧をカンマ区切りで取得します
getPointObject(stationName) object 駅名を指定し、駅一覧から地点オブジェクトを取得します
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
name 名称(Read Only)
code 駅コード(Read Only)
kenCode 都道府県コード(Read Only)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)
minute 起点駅からの時間(分)を表す要素(Read Only)

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

パラメータ名内容デフォルト値
transferCount 乗り換え回数(int)の指定を行います 乗り換え回数を考慮しない

路線図パーツ

書式解説
expGuiMap(container [, configure ]) container の中に路線図に必要な HTMLElement を生成します。configureにパラメータを指定します。
var mapApp = new expGuiMap(document.getElementById("map"));
書式戻り値解説
dispMap(mapPrefix [, listener ]) なし 指定した路線図を表示します。
第一引数に路線図識別子を指定して利用します。
第二引数のlistenerは、この関数の処理が終了したタイミングで呼び出される関数を指定することができます。
成功した場合は、true が設定されます。
また、この関数は裏で通信を行っているので処理のタイミングに依存した処理を行っている場合、不都合が生じる場合があります。その場合は listener に処理を記述してください。listenerの利用でこの関数の処理終了後に処理を続行することができます。
なお listener は第二引数に駅コードを受け取ることができます。(参照:路線図識別子について)(参照:listener の使用例)
dispMapStation(stCode, mapPrefix [, listener ]) なし 指定した駅が中心になるように路線図を表示します。
第一引数に駅コード、第二引数に路線図識別子を指定して利用します。以降の引数は不要な場合省略することができます。
第三引数のlistenerは、この関数の処理が終了したタイミングで呼び出される関数を指定することができます。
路線図上に駅が存在しないなどエラーが発生した場合は listener の第一引数に false が設定されます。成功した場合は、true が設定されます。
また、この関数は裏で通信を行っているので処理のタイミングに依存した処理を行っている場合、不都合が生じる場合があります。その場合は listener に処理を記述してください。listenerの利用でこの関数の処理終了後に処理を続行することができます。
なお listener は第二引数に駅コードを受け取ることができます。(参照:路線図識別子について)(参照:listener の使用例)
dispMapCenterPoint(point) なし 指定した座標が中心になるように路線図を表示します。
pointにはCMapPointを指定します。
なお、指定した座標が画面外で合った場合、画面内に収まるように補正されます。
showOnStation(stCode,style) なし 指定された駅を選択状態にします。
第一引数に駅コード、第二引数には駅を選択する際の選択種別を指定します。
なお、駅コードは配列による複数指定も可能です。
getMapPrefix() string 表示されている路線図の識別子を返します。
getMapCenterPoint() object 表示されている路線図の中心座標をCMapPointとして返します。
setConfigure(key, value) なし 地図の初期化後に設定を変更します。
第一引数にパラメータ名、第二引数に設定値を指定します。
bind(event, listener) なし イベントハンドラを登録します。
第一引数にイベント名、第二引数には、イベント発生時に呼び出される関数を指定することができます。
unbind(event) なし イベントを解除します
パラメータ名内容デフォルト値
navi 概観図を有効にします。 false
(無効)
cursor カーソルを有効にします。 false
(無効)
zoom 拡大縮小を有効にします。 false
(無効)
doubleClickZoom ダブルクリックで地図のズームインを有効にします。 false
(無効)
continuousZoom ズーム時に、滑らかなアニメーション処理を有効にします。 false
(無効)
dragging ドラッグ操作で路線図を移動可能にします。 true
(有効)
イベント名イベントハンドラに渡される引数解説
click 地点オブジェクト 路線図上の駅がクリックされたときに発生します。クリックされた位置の駅情報が渡されます。
メンバー名解説
code 駅コード(Read Only)
name 名称(Read Only)
yomi 読みかな(Read Only)
lati 緯度 (度.分.秒.100分の1秒)(Read Only)
lati_d 緯度 (度)(Read Only)
longi 経度 (度.分.秒.100分の1秒)(Read Only)
longi_d 経度 (度)(Read Only)
kenCode 都道府県コード(Read Only)
type 交通種別(Read Only)
type_detail より詳細な交通種別(Read Only)

※地点オブジェクトはクリックイベントの引数でのみ自動的に作られます。直接生成せずにクリックイベントを経由して使用してください。

CUserInterface は路線図を操作するための基本的なインターフェースを提供します。CUserInterface オブジェクトは CMapApp オブジェクトの生成時に自動的に作られます。直接生成せずに CMapApp クラスを経由して使用してください。

関数

書式戻り値解説
mapMove(x, y) なし 指定したピクセル分スクロールします。
setScale(scale) なし 指定した倍率に変更します。

CMapPoint は路線図の表示座標を表すクラスです。

構築

書式解説
CMapPoint(x, y, mapPrefix) X座標、Y座標、路線図識別子を指定して生成します。

関数

書式戻り値解説
getX() int X座標の取得
getY() int Y座標の取得
getMapPrefix() string 路線図識別子の取得
全域
識別子説明
jpnx1 全域(100%)
jpnx2 全域(200%)
jpnx4 全域(400%)
近郊
識別子説明
tokyo 東京近郊
hd_tokyo 東京近郊(高解像度版)※
nagoya 名古屋近郊
hd_nagoya 名古屋近郊(高解像度版)※
osaka 大阪近郊
hd_osaka 大阪近郊(高解像度版)※
fukuoka 福岡近郊
hd_fukuoka 福岡近郊(高解像度版)※
地下鉄
識別子説明
s_sappor 札幌
s_sendai 仙台
s_tokyo 東京
s_yokoha 横浜
s_nagoya 名古屋
s_kyoto 京都
s_osaka 大阪
s_kobe 神戸
s_fukuok 福岡

※ 高解像度版はより鮮明な表示となりますが、通信データサイズが増加します。なお、高解像度版は通常版の約4倍の解像度となります。

バージョン情報パーツ

書式解説
expGuiVersion() 駅情報オブジェクトを生成します。
var version = new expGuiVersion();
書式戻り値解説
getVersion([, listener ]) なし バージョンを取得します
getApiVersion() string APIのバージョンを取得します
getEngineVersion() string 駅すぱあとエンジンのバージョンを取得します
getVersionList() Array 各バージョンオブジェクトを配列で取得します
getCompanyName(companyId) string 権利団体の名称を取得します※companyId=2のみ対応
getCopyrights(companyId) string 著作権を取得します※companyId=2のみ対応
setConfigure(name, value) なし 環境設定変更を行います
メンバー名解説
caption バージョンの見出し(Read Only)
version バージョンを表す要素(Read Only)
rangeCaption 有効期間を表現する文字列(Read Only)
rangeFrom 有効期間の開始(Read Only)
rangeTo 有効期間の終了(Read Only)

※バージョンオブジェクトはgetVersionListの戻り値でのみ定義されます。

拡張ツールパーツ

書式解説
expGuiTools() 拡張ツールオブジェクトを生成します。
var expTools = new expGuiTools();
書式戻り値解説
json2xml(json) string jsonをxmlに変換します
xml2json(xml) string xmlをjsonに変換します

※json,xml共に文字列で渡してください。

補足説明

全パーツ「etConfigure」で参照するAPIのURL、および、対象端末(GUIが含まれるパーツのみ)を制御することが出来ます。
なお、通常は自動判定されるため、変更の必要はありません。

パラメータ名内容
apiURL APIのURLを指定します
agent 指定した端末種別向けのデザインに変更します
識別子説明
AGENT_PC PC向けのデザインに変更します
AGENT_PHONE スマートフォン向けのデザインに変更します
AGENT_TABLET タブレット向けのデザインに変更します

※端末種別の指定は指定した端末以外を制限するものではありません。

Indexへ戻る
Val Laboratory