YOLP(地図)

YDF クラス

SilverlightマップAPIは、2014年5月31日をもって廃止いたします。他のYOLP地図APIへの移行をお願いいたします。Yahoo! JavaScriptマップAPI、もしくはYahoo!スタティックマップAPIをご利用ください。

YDF クラス

クラス一覧へ

Class YDF

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDF

Summary

YDF(YOLP Data Format)

YOLP内で扱うデータの統一フォーマットです。

Constructor Summary

属性 コンストラクタ名と説明
 
YDF()
コンストラクタ

Field Summary

属性 フィールド名と説明
 
YDFのDictionary要素
 
YDFのFeature要素
 
地物
 
YDFのResultInfo要素

Constructor Detail

  • YDF()
    コンストラクタ

Field Detail

  • {YDFDictionary} Dictionary
    YDFのDictionary要素
    複数の項目間で共有できる情報を収める要素です。
  • {System.Collections.Generic.IList{YDFFeature}} Feature
    YDFのFeature要素
  • {System.Collections.Generic.List{Feature}} Features
    地物
  • {YDFResultInfo} ResultInfo
    YDFのResultInfo要素
    API実行結果です。



Class YDFAddressElement

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFAddressElement

Summary

YDFのAddressElement要素

住所構造データを表します。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
行政コード
 
住所読み仮名
 
住所レベル
 
住所文字列
 
Where On Earth ID

Constructor Detail

  • YDFAddressElement()
    コンストラクタ

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} WoeID
    Where On Earth ID



Class YDFDictionary

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFDictionary

Summary

YDFのDictionary要素

複数の項目間で共有できる情報を収めます。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
YDFのDictionary要素のJSONデータ

Constructor Detail

  • YDFDictionary()
    コンストラクタ

Field Detail

  • {System.Collections.Generic.Dictionary{System.String,System.Json.JsonObject}} Jsons
    YDFのDictionary要素のJSONデータ
    キー:Id、値:対応するJSONデータです。



Class YDFEdge

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFEdge

Summary

YDFのEdge要素

ルート検索結果の経路を構成するリンクデータです。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
YDFのVertex要素

Constructor Detail

  • YDFEdge()
    コンストラクタ

Field Detail

  • {System.Collections.Generic.IList{YDFVertex}} Vertex
    YDFのVertex要素



Class YDFFeature

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFFeature

Summary

YDFのFeature要素

地図上のアイコンや検索結果リストの1行に表示される拠点情報を表します。detailパラメータで指定する出力レベルにより出力項目が異なります。標準モードのPropertyは、APIでの出力処理で出力項目を設定します。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
カテゴリ(複数指定可能)
 
拠点の説明(HTML指定可能)
 
YDFのGeometry要素
 
拠点名称
 
YDFのRouteInfo要素
 
YDFのStyle要素

Constructor Detail

  • YDFFeature()
    コンストラクタ

Field Detail

  • {System.Collections.Generic.IList{System.String}} Category
    カテゴリ(複数指定可能)
  • {System.String} Description
    拠点の説明(HTML指定可能)
  • {YDFGeometry} Geometry
    YDFのGeometry要素
  • {System.String} Name
    拠点名称
  • {YDFRouteInfo} RouteInfo
    YDFのRouteInfo要素
  • {YDFStyle} Style
    YDFのStyle要素



Class YDFGeometry

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFGeometry

Summary

YDFのGeometry要素

拠点の場所を表します。点だけでなく線や多角形でも指定できます。Targetがある場合は、指定されたIdを持つDictionary要素内のGeometryへの参照となります。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
表示範囲の地理座標矩形領域
 
圧縮座標
 
圧縮仕様
 
地理座標
 
測地系
 
ポリゴンの外側の地理座標
 
ポリゴンの内側の地理座標
 
子要素として持つYDFのGeometry要素
 
半径(m)
 
図形種別

Constructor Detail

  • YDFGeometry()
    コンストラクタ

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.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFImage

Summary

YDFのImage要素

Image要素は以下の子要素を持ち、画像URLだけでなく、表示崩れを防ぐため、縦横サイズも必須項目とします。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
画像の説明
 
画像の縦幅
 
Url
画像URL
 
画像の横幅

Constructor Detail

  • YDFImage()
    コンストラクタ

Field Detail

  • {System.String} Caption
    画像の説明
  • {System.String} Height
    画像の縦幅
  • {System.String} Url
    画像URL
  • {System.String} Width
    画像の横幅



Class YDFJson

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson

Summary

JSONの情報ストア

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
Id
識別子
set:protected
パース前のJSONデータ
 
YDFのProperty要素
 
参照する要素の識別子

Constructor Detail

  • YDFJson()
    コンストラクタ

Field Detail

  • {System.String} Id
    識別子
  • {System.Json.JsonValue} Json
    パース前のJSONデータ
    Targetが指定されている場合は該当するYDFDictionaryのデータに置き換えられます。
  • {YDFProperty} Property
    YDFのProperty要素
  • {System.String} Target
    参照する要素の識別子



Class YDFProperty

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFProperty

Summary

YDFのProperty要素

拠点の持つ各種データを表します。データ名と値が一対となったデータ形式、または一つのデータ名に対し値が複数含まれる配列形式となります。Targetがある場合は、指定されたIdを持つDictionary要素内の同じデータ名のProperty要素への参照となります。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
アクセス方法
 
住所
 
YDFのAddressElement要素
 
営業終了時間
 
営業時間
 
営業開始時間
 
カセットID
 
キャッチコピー
 
作成日時
 
詳細
 
イベント終了日
 
イベント開始日
 
Fax
FAX番号
 
休日
 
YDFのImage要素
 
データ名
 
支払い方法
 
掲載終了日
 
掲載開始日
 
評価
 
投稿数
 
詳細なデータがある位置のURL
 
Tel
電話番号
 
更新日時
 
文字列またはYDFのProperty要素
 
郵便番号

Constructor Detail

  • YDFProperty()
    コンストラクタ

Field Detail

  • {System.String} Access
    アクセス方法
  • {System.String} Address
    住所
  • {System.Collections.Generic.IList{YDFAddressElement}} AddressElement
    YDFの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} Fax
    FAX番号
  • {System.String} Holiday
    休日
    文字列で指定します(例:木曜定休日)。
  • {System.Collections.Generic.IList{YDFImage}} Image
    YDFの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.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFResultInfo

Summary

YDFのResultInfo要素

API実行結果です。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
地理座標矩形領域
 
コピーライト
 
表示件数
 
説明
 
End
終了番号
 
API処理時間
 
開始番号
 
HTTPステータス
 
合計件数

Constructor Detail

  • YDFResultInfo()
    コンストラクタ

Field Detail

  • {LatLngBounds} Bounds
    地理座標矩形領域
  • {System.String} Copyright
    コピーライト
  • {System.Int32} Count
    表示件数
  • {System.String} Description
    説明
  • {System.Int32} End
    終了番号
  • {System.Double} Latency
    API処理時間
  • {System.Int32} Start
    開始番号
  • {System.Int32} Status
    HTTPステータス
  • {System.Int32} Total
    合計件数



Class YDFRouteInfo

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFRouteInfo

Summary

YDFのRouteInfo要素

ルート検索結果の経路詳細情報を含めます。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
YDFのEdge要素

Constructor Detail

  • YDFRouteInfo()
    コンストラクタ

Field Detail

  • {System.Collections.Generic.IList{YDFEdge}} Edge
    YDFのEdge要素



Class YDFStyle

NameSpace

YahooJapan.OpenLocalPlatform.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFStyle

Summary

YDFのStyle要素

拠点を可視化する表示形式を表します。アイコンと線および塗りつぶしで指定されます。Targetがある場合は、指定されたIdを持つDictionary要素内のStyleへの参照となります。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
表示位置
 
 
終点スタイル
 
アイコン画像
 
透過率
 
サイズ
 
始点スタイル
 
種別(icon、line、fill)

Constructor Detail

  • YDFStyle()
    コンストラクタ

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.GeoClient

Extends

System.Object
   ∟YDFJson
      ∟YDFVertex

Summary

YDFのVertex要素

ルート検索結果の経路のリンクデータを構成する拠点データを含めます。

Constructor Summary

属性 コンストラクタ名と説明
 
コンストラクタ

Field Summary

属性 フィールド名と説明
 
駅情報
 
拠点種別

Constructor Detail

  • YDFVertex()
    コンストラクタ

Field Detail

  • {System.String} Station
    駅情報
    拠点が駅の場合のみ。
  • {System.String} Type
    拠点種別
    StartまたはEnd。