YDF クラス
SilverlightマップAPIは、2014年5月31日をもって廃止いたします。他のYOLP地図APIへの移行をお願いいたします。Yahoo! JavaScriptマップAPI、もしくはYahoo!スタティックマップAPIをご利用ください。YDF クラス
- YDF
YDF(YOLP Data Format) - YDFAddressElement
YDFのAddressElement要素 - YDFDictionary
YDFのDictionary要素 - YDFEdge
YDFのEdge要素 - YDFFeature
YDFのFeature要素 - YDFGeometry
YDFのGeometry要素 - YDFImage
YDFのImage要素 - YDFJson
JSONの情報ストア - YDFProperty
YDFのProperty要素 - YDFResultInfo
YDFのResultInfo要素 - YDFRouteInfo
YDFのRouteInfo要素 - YDFStyle
YDFのStyle要素 - YDFVertex
YDFのVertex要素
Class YDF
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDF
Summary
YDF(YOLP Data Format)
YOLP内で扱うデータの統一フォーマットです。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
YDF()
コンストラクタ |
Field Summary
属性 | フィールド名と説明 |
---|---|
YDFのDictionary要素 |
|
YDFのFeature要素 |
|
地物 |
|
YDFのResultInfo要素 |
Constructor Detail
Field Detail
-
{YDFDictionary} DictionaryYDFのDictionary要素複数の項目間で共有できる情報を収める要素です。
-
{System.Collections.Generic.IList{YDFFeature}} FeatureYDFのFeature要素
-
{System.Collections.Generic.List{Feature}} Features地物
-
{YDFResultInfo} ResultInfoYDFのResultInfo要素API実行結果です。
Class YDFAddressElement
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFAddressElement
Summary
YDFのAddressElement要素
住所構造データを表します。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ |
Field Summary
属性 | フィールド名と説明 |
---|---|
行政コード
|
|
住所読み仮名
|
|
住所レベル
|
|
住所文字列
|
|
Where On Earth ID
|
Constructor Detail
Field Detail
-
{System.String} Code行政コード部分住所のレベルごとに、けた数が異なります。
-
{System.String} Kana住所読み仮名azaレベルまでです。
-
{System.String} Level住所レベル* prefecture - 都道府県(行政コード2けた)
* city - 市区町村(行政コード5けた)
* major_city - 政令指定都市の市部(行政コード5けた、下2けたは00)
* ward - 政令指定都市の区(行政コード5けた、cityと同じ)
* county - 郡名(行政コードなし)
* oaza - 大字(行政コードなし)
* aza - 字(行政コードなし)
* detail1 - 番地以降(行政コードなし)
* detail2 - 番地以降(行政コードなし)
-
{System.String} Name住所文字列
-
{System.String} WoeIDWhere On Earth ID
Class YDFDictionary
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFDictionary
Summary
YDFのDictionary要素
複数の項目間で共有できる情報を収めます。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
YDFのDictionary要素のJSONデータ |
Constructor Detail
Field Detail
Class YDFEdge
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFEdge
Summary
YDFのEdge要素
ルート検索結果の経路を構成するリンクデータです。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
YDFEdge()
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
YDFのVertex要素 |
Class YDFFeature
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFFeature
Summary
YDFのFeature要素
地図上のアイコンや検索結果リストの1行に表示される拠点情報を表します。detailパラメータで指定する出力レベルにより出力項目が異なります。標準モードのPropertyは、APIでの出力処理で出力項目を設定します。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
カテゴリ(複数指定可能) |
|
拠点の説明(HTML指定可能) |
|
YDFのGeometry要素 |
|
拠点名称 |
|
YDFのRouteInfo要素 |
|
YDFのStyle要素 |
Constructor Detail
Field Detail
-
{System.Collections.Generic.IList{System.String}} Categoryカテゴリ(複数指定可能)
-
{System.String} Description拠点の説明(HTML指定可能)
-
{YDFGeometry} GeometryYDFのGeometry要素
-
{System.String} Name拠点名称
-
{YDFRouteInfo} RouteInfoYDFのRouteInfo要素
-
{YDFStyle} StyleYDFのStyle要素
Class YDFGeometry
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFGeometry
Summary
YDFのGeometry要素
拠点の場所を表します。点だけでなく線や多角形でも指定できます。Targetがある場合は、指定されたIdを持つDictionary要素内のGeometryへの参照となります。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
表示範囲の地理座標矩形領域 |
|
圧縮座標 |
|
圧縮仕様 |
|
地理座標 |
|
測地系 |
|
ポリゴンの外側の地理座標 |
|
ポリゴンの内側の地理座標 |
|
子要素として持つYDFのGeometry要素 |
|
半径(m) |
|
図形種別 |
Constructor Detail
Field Detail
-
{LatLngBounds} BoundingBox表示範囲の地理座標矩形領域図形を囲う矩形領域の左下座標と右上座標をスペースで区切って、「経度,緯度」形式の十進度で指定します。
-
{System.String} Compress圧縮座標座標データが非常に多い場合、圧縮して指定します。
-
{System.String} CompressType圧縮仕様Compress要素の圧縮仕様を指定します。
-
{System.Collections.Generic.IList{LatLng}} Coordinates地理座標「経度,緯度」形式の十進度で指定します。複数ある場合はスペース(0x20)で区切ります。
-
{System.String} Datum測地系wgs(世界測地系)、tky(日本測地系)のいずれかで指定します。デフォルトはwgsです。
-
{System.Collections.Generic.IList{LatLng}} Exteriorポリゴンの外側の地理座標子要素に1個のcoordinatesを持ちます。図形種別がpolygonの場合、ExteriorとInteriorを使って、穴あきの図形を表現できます。外側座標だけの場合は、coordinatesだけの指定も可能です。
-
{System.Collections.Generic.IList{LatLng}} Interiorポリゴンの内側の地理座標子要素に1個のcoordinatesを持ちます。図形種別がpolygonの場合、ExteriorとInteriorを使って、穴あきの図形を表現できます。外側座標だけの場合は、coordinatesだけの指定も可能です。
-
{System.Collections.Generic.List{YDFGeometry}} Multigeometry子要素として持つYDFのGeometry要素図形種別がmultigeometryの場合は、子要素として複数のGeometryを指定して、図形をグループ化できます。multigeometryのcoordinatesは指定できません。
-
{System.String} Radius半径(m)図形種別がcircleの場合は1個、ellipseの場合は「横半径,縦半径」形式で指定します。
-
{System.String} Type図形種別点:point、線:linestring、多角形:polygon、円:circle、楕円(だえん):ellipse、図形グループ:multigeometryのいずれかを指定します。
Class YDFImage
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFImage
Summary
YDFのImage要素
Image要素は以下の子要素を持ち、画像URLだけでなく、表示崩れを防ぐため、縦横サイズも必須項目とします。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
YDFImage()
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
画像の説明 |
|
画像の縦幅 |
|
画像URL |
|
画像の横幅 |
Constructor Detail
Field Detail
Class YDFJson
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
Summary
JSONの情報ストア
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
YDFJson()
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
識別子 |
|
set:protected |
パース前のJSONデータ |
YDFのProperty要素 |
|
参照する要素の識別子 |
Constructor Detail
Field Detail
-
{System.String} Id識別子
-
{System.Json.JsonValue} Jsonパース前のJSONデータTargetが指定されている場合は該当するYDFDictionaryのデータに置き換えられます。
-
{YDFProperty} PropertyYDFのProperty要素
-
{System.String} Target参照する要素の識別子
Class YDFProperty
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFProperty
Summary
YDFのProperty要素
拠点の持つ各種データを表します。データ名と値が一対となったデータ形式、または一つのデータ名に対し値が複数含まれる配列形式となります。Targetがある場合は、指定されたIdを持つDictionary要素内の同じデータ名のProperty要素への参照となります。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
アクセス方法 |
|
住所 |
|
YDFのAddressElement要素 |
|
営業終了時間 |
|
営業時間 |
|
営業開始時間 |
|
カセットID |
|
キャッチコピー |
|
作成日時 |
|
詳細 |
|
イベント終了日 |
|
イベント開始日 |
|
FAX番号 |
|
休日 |
|
YDFのImage要素 |
|
データ名 |
|
支払い方法 |
|
掲載終了日 |
|
掲載開始日 |
|
評価 |
|
投稿数 |
|
詳細なデータがある位置のURL |
|
電話番号 |
|
更新日時 |
|
文字列またはYDFのProperty要素 |
|
郵便番号 |
Constructor Detail
Field Detail
-
{System.String} Accessアクセス方法
-
{System.String} Address住所
-
{System.Collections.Generic.IList{YDFAddressElement}} AddressElementYDFのAddressElement要素
-
{System.String} BusinessClose営業終了時間24H:mm形式で指定します(例:21:00)。
-
{System.String} BusinessHour営業時間文字列で指定します(例:月火水金土 9:00~18:00、日・祝 9:00~12:00)。
-
{System.String} BusinessOpen営業開始時間24H:mm形式で指定します(例:10:30)。
-
{System.String} CassetteIdカセットID
-
{System.String} CatchCopyキャッチコピー
-
{System.String} CreateDate作成日時YYYY-MM-DD 24H:mm形式で指定します(例:2009-12-11 14:30)。
-
{System.String} Description詳細
-
{System.String} EventEndイベント終了日YYYY-MM-DD形式で指定します(例:2010-01-11)。
-
{System.String} EventStartイベント開始日YYYY-MM-DD形式で指定します(例:2010-01-09)。
-
{System.String} FaxFAX番号
-
{System.String} Holiday休日文字列で指定します(例:木曜定休日)。
-
{System.Collections.Generic.IList{YDFImage}} ImageYDFのImage要素
-
{System.String} Nameデータ名
-
{System.String} Payment支払い方法文字列による説明です(例:クレジットカードOK、VISA、MASTER)。
-
{System.String} PublishEnd掲載終了日YYYY-MM-DD形式で指定します(例:2010-01-11)。
-
{System.String} PublishStart掲載開始日YYYY-MM-DD形式で指定します(例:2010-01-01)。
-
{System.String} Rating評価5点満点評価です(例:3.3)。
-
{System.String} ReviewCount投稿数評価(Rating)の基となるデータ件数です。
-
{System.String} StorageUrl詳細なデータがある位置のURL
-
{System.String} Tel電話番号
-
{System.String} UpdateDate更新日時YYYY-MM-DD 24H:mm形式で指定します(例:2010-02-11 18:43)。
-
{System.String} Value文字列またはYDFのProperty要素
-
{System.String} ZipCode郵便番号
Class YDFResultInfo
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFResultInfo
Summary
YDFのResultInfo要素
API実行結果です。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
地理座標矩形領域 |
|
コピーライト |
|
表示件数 |
|
説明 |
|
終了番号 |
|
API処理時間 |
|
開始番号 |
|
HTTPステータス |
|
合計件数 |
Constructor Detail
Field Detail
-
{LatLngBounds} Bounds地理座標矩形領域
-
{System.String} Copyrightコピーライト
-
{System.Int32} Count表示件数
-
{System.String} Description説明
-
{System.Int32} End終了番号
-
{System.Double} LatencyAPI処理時間
-
{System.Int32} Start開始番号
-
{System.Int32} StatusHTTPステータス
-
{System.Int32} Total合計件数
Class YDFRouteInfo
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFRouteInfo
Summary
YDFのRouteInfo要素
ルート検索結果の経路詳細情報を含めます。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
YDFのEdge要素 |
Class YDFStyle
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFStyle
Summary
YDFのStyle要素
拠点を可視化する表示形式を表します。アイコンと線および塗りつぶしで指定されます。Targetがある場合は、指定されたIdを持つDictionary要素内のStyleへの参照となります。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
YDFStyle()
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
表示位置 |
|
色 |
|
終点スタイル |
|
アイコン画像 |
|
透過率 |
|
サイズ |
|
始点スタイル |
|
種別(icon、line、fill) |
Constructor Detail
Field Detail
-
{System.String} Anchor表示位置アイコン画像左上を基点とする表示位置です。「,」区切りで横方向と縦方向の差分をピクセル値で指定します。
-
{System.String} Color色RGBの16進表記で指定します。
-
{System.String} EndLine終点スタイル図形種別がlinestringの場合、arrow(矢印)を指定可能です。
-
{System.String} Imageアイコン画像図形種別がiconの場合、アイコンとして使用する画像URLを指定します。
-
{System.Double} Opacity透過率パーセントで指定します。
-
{System.String} Sizeサイズアイコン画像のサイズまたは線幅をピクセル値で指定します。図形種別がiconの場合、「,」区切りで横幅と縦幅を指定可能です。
-
{System.String} StartLine始点スタイル図形種別がlinestringの場合、arrow(矢印)を指定可能です。
-
{System.String} Type種別(icon、line、fill)
Class YDFVertex
NameSpace
YahooJapan.OpenLocalPlatform.GeoClientExtends
System.Object∟YDFJson
∟YDFVertex
Summary
YDFのVertex要素
ルート検索結果の経路のリンクデータを構成する拠点データを含めます。
Constructor Summary
属性 | コンストラクタ名と説明 |
---|---|
コンストラクタ
|
Field Summary
属性 | フィールド名と説明 |
---|---|
駅情報 |
|
拠点種別 |