APIレファレンス

Yahoo! iOSマップSDKのAPIレファレンスを示します。

クラス

クラス メソッド・属性 概要
YMKMapView 地図の移動、スケールの変更、地図種類の切り替え、現在位置の表示等、地図に関する基本的な操作を行います。
プロパティー mapType 表示される地図データの種類を取得・設定します。
zoomEnabled ユーザーがピンチ操作での地図の拡大縮小操作をすることを許可するかどうかを取得・設定します。
scrollEnabled ユーザーのスクロール操作を許可するかどうかを取得・設定します。
scalebarVisible 地図上にスケールバーを表示するかどうかをを取得・設定します。
delegate デリゲートを取得・設定します。
region 地図表示中の領域を取得・設定します。
centerCoordinate 地図の中心座標を取得・設定します。
showsUserLocation 現在位置を地図上に表示するかどうかを取得・設定します。
userLocationVisible 表示中の地図に現在位置が表示されているかどうかを取得します(読み取り専用)。
userLocation 現在位置に関するオブジェクトを取得します(読み取り専用)。
annotations 登録されているYMKAnnotationを配列で返します。
selectedAnnotations 選択されたYMKAnnotationを配列で返します。
メソッド initWithFrame:appid: YMKMapViewを初期化します。
setMapType:mapStyle:
mapStyleParam:
表示される地図データの種類を設定します。
setRegion:animated: 表示中の地図範囲を変更します。アニメーションすることも可能です。
setCenterCoordinate:
animated:
表示中の地図の中心座標を変更します。アニメーションすることも可能です。
addAnnotation: 指定されたYMKAnnotationを地図ビューに追加します。
addAnnotations: 配列に格納されたYMKAnnotationを一括で地図ビューに追加します。
removeAnnotation: 指定されたYMKAnnotationを地図ビューから削除します。
removeAnnotations: 配列に格納されたYMKAnnotationを一括で地図ビューから削除します。
viewForAnnotation: 指定したYMKAnnotationに関連付けられたYMKAnnotationViewインスタンスを返します。
dequeueReusableAnnotation
ViewWithIdentifier:
指定された判別文字列に一致するYMKAnnotationViewインスタンスを返します。
selectAnnotation:animated: 指定したYMKAnnotationに一致するYMKAnnotationViewを選択状態にします。
deselectAnnotation:animated: 指定したYMKAnnotationに一致するYMKAnnotationViewを未選択状態にします。
addOverlay: 指定したYMKOverlayを地図ビューに追加します。
addOverlays: 配列に格納したYMKOverlayを一括で地図ビューに追加します。
removeOverlay: 指定したYMKOverlayを地図ビューから削除します。
removeOverlays: 配列に格納したYMKOverlayを一括で地図ビューから削除します。
insertOverlay:atIndex: 指定した階層にYMKOverlayを追加します。
viewForOverlay: 指定したYMKAnnotationに関連付けられたYMKAnnotationViewインスタンスを返します。
convertCoordinate:
toPointToView:
緯度経度を画面座標に変換します。
convertPoint:
toCoordinateFromView:
指定したViewの座標系の座標値を緯度経度に変換します。
convertRegion:
toRectToView:
緯度経度の地図領域を指定のViewの座標系の長方形に変換します。
convertRect:
toRegionFromView:
指定のViewの座標系の長方形を緯度経度の地図領域に変換します。
regionThatFits: 指定した領域を、地図表示枠に一致するようにアスペクト比を調整します。
定数 YMKMapType 地図の種類です。
YMKAnnotationView 地図Viewに対して、アイコン等のイメージを表示することができるクラスです。
プロパティー annotation YMKAnnotationViewに設定されているannotationオブジェクトのプロパティー。
image YMKAnnotationViewに表示するイメージプロパティー。
centerOffset YMKAnnotationViewに設定されているImageのオフセット値。
enabled 注記を表示するかどうかの設定プロパティー。
selected YMKAnnotationViewの選択状態プロパティー。
leftCalloutAccessoryView 吹き出しの左に表示するViewプロパティー。ボタンViewの設定等に使用します。
rightCalloutAccessoryView 吹き出しの右に表示するViewプロパティー。ボタンViewの設定等に使用します。
reuseIdentifier YMKAnnotationViewを識別するための文字列用プロパティー。
calloutOffset 吹き出しのオフセット値。
メソッド initWithAnnotation:
reuseIdentifier:
YMKAnnotationViewの初期化用メソッドです。
setSelected:animated: YMKAnnotationViewの選択状態を変更します。
YMKPinAnnotationView 地図上に表示するピンアイコンのアニメーション、色を設定して表示するためのViewクラスです。
プロパティー pinColor ピンカラーのプロパティー。
animatesDrop ピンがドロップされる際のアニメーション指定用プロパティー。
定数 YMKPinAnnotationColor ピンカラー用の定数です。
YMKUserLocation デバイスの現在位置を取得します。
プロパティー location デバイスの現在位置(読み取り専用)。
updating ユーザー位置が更新されているかどうかが確認できます(読み取り専用)。
title ユーザー位置アイコンのタイトル。
subtitle ユーザー位置アイコンのサブタイトル。
YMKOverlayView 図形表示を行うためのViewクラスです。
プロパティー overlay YMKOverlayViewに設定されているOverlayオブジェクトのプロパティー。
メソッド initWithOverlay:overlay: YMKOverlayViewの初期化用メソッドです。
YMKOverlayPathView 地図ビューに表示する図形の、線の太さ、線の色、塗りつぶし色の設定を行うためのクラスです。
プロパティー fillColor 塗りつぶし色のプロパティー。
strokeColor 線の色のプロパティー。
lineWidth 線の太さのプロパティー。
YMKPolyline ポリラインのポイント情報を設定するためのクラスです。
メソッド polylineWithCoordinates:
count:
指定されたCLLocationCoordinate2D配列から、YMKPolylineオブジェクトを生成するメソッドです。
polylineWithPoints:count: 指定されたYMKMapPoint配列から、YMKPolylineオブジェクトを生成するメソッドです。
YMKPolylineView 地図上にポリラインを描画するためのViewクラスです。
プロパティー polyline YMKPolylineViewに設定されているYMKPolylineオブジェクトのプロパティー。
メソッド initWithPolyline: YMKPolylineViewの初期化用メソッドです。
YMKCircle 円の中心座標、半径等を設定するためのクラスです。
プロパティー coordinate YMKCircleに設定されている円の中心緯度経度プロパティー。
radius YMKCircleに設定されている円の半径(メートル)プロパティー。
boundingMapRect YMKCircleに設定されている円の制限長方形プロパティー。
メソッド circleWithCenterCoordinate:
radius:
指定された中心緯度経度・半径からYMKCircleオブジェクトを生成するメソッドです。
circleWithMapRect: 指定された制限長方形からYMKCircleオブジェクトを生成するメソッドです。
YMKCircleView 地図上に円を表示するためのViewクラスです。
プロパティー circle YMKCircleViewに設定されているYMKCircleオブジェクトのプロパティー。
メソッド initWithCircle: YMKCircleViewの初期化用メソッドです。
YMKPolygon ポリゴンのポイント情報を設定するためのクラスです。
メソッド polygonWithCoordinates:
count:
指定された緯度経度配列からYMKCircleオブジェクトを作成するメソッドです。
YMKPolygonView 地図上にポリゴンを表示するためのViewクラスです。
プロパティー polygon YMKPolygonViewに設定されているYMKPolygonオブジェクトのプロパティー。
メソッド initWithPolygon: YMKPolygonViewの初期化用メソッドです。
YMKMultiPoint 図形のポイント情報を管理するクラスです。
プロパティー pointCount YMKMultiPointに設定されているpoints配列数プロパティー。
points YMKMultiPointに設定されているYMKMapPoint配列プロパティー。
YMKYDFManager YDFの情報を読み込み、表示するためのクラスです。
メソッド initWithUrlString: YMKYDFManagerの初期化用メソッドです。指定したURLからYDFを取得して初期化します。
initWithXmlString: YMKYDFManagerの初期化用メソッドです。XML形式のYDFデータから初期化します。
initWithJsonString: YMKYDFManagerの初期化用メソッドです。JSON形式のYDFデータから初期化します。
showWithMapView: 地図上にYDFデータを表示します。
remove: 地図上からYDFデータを削除します。
YMKLabelTouchManager 注記情報を取得する機能を提供するクラスです。
プロパティー delegate デリゲートを取得・設定します。
メソッド initWithMapView: YMKLabelTouchManagerの初期化用メソッドです。
queryLabel: 指定位置の注記情報を取得します。
YMKLabelInfo タップされた注記情報が格納されます。
プロパティー type 注記種別です。
label 文字列注記の際の文字列です。
name 注記の名称です。
angle 注記の回転角です。
vertical 文字列注記の縦書きフラグです。
YMKRouteOverlay 緯度経度指定によるルート検索およびルート表示を行うOverlayクラスです。
プロパティー distance ルートの距離をメートルで返します。
time ルートの移動にかかる時間を分で返します。
nodeInfoCount 経由点の数を返します。
delegate デリゲートを取得設定します。
メソッド initWithAppid: YMKRouteOverlayの初期化を行います。
setRouteStartPos:withGoalPos:
withTraffic:
検索したいルートの出発地、目的地、移動手段の設定を行います。
search ルート検索を開始します。検索完了後はYMKRouteOverlayDelegateにイベントが返されます。
getRouteNodeInfoWithIndex 出発地からi番目の経由点情報(案内ポイント)を返します。
setStartTitle: 出発地ピンの吹き出しタイトルの設定を行います。
setGoalTitle: 目的地ピンの吹き出しタイトルの設定を行います。
YMKRouteOverlayView ルート情報の表示を行うOverlayViewクラスです。
プロパティー routeOverlay YMKRouteOverlayViewに設定されているYMKRouteOverlayインスタンスです。
startPinVisible 出発地ピンの表示設定を行います。
goalPinVisible 目的地ピンの表示設定を行います。
routePinVisible 経由点ピンの表示設定を行います。
メソッド initWithRouteOverlay: YMKRouteOverlayView初期化用メソッドです。
YMKNaviController GPS、コンパスを用いてルート案内を行うクラスです。
プロパティー delegate デリゲートを取得設定します。ルート案内をイベントとして返します。
メソッド initWithRouteOverlay: YMKNaviControllerの初期化を行います。
getTotalDistance: ルートの総距離をメートルで返します。
getTotalTime: ルートの移動にかかる時間を分で返します。
getDistanceOfRemainder: ルート上の現在位置から目的地までの距離をメートルで返します。
getTimeOfRemainder: ルート上の現在位置から目的地までの移動にかかる時間を分で返します。
start: GPS、コンパスを起動し案内を開始します。
stop: GPS、コンパスを停止し案内を終了します。
setARKViewController: YARKViewControllerインスタンスを設定します。
setMapView: YMKMapViewインスタンスを設定します。
YARKViewController ARビューを表示するためのコントロールクラスです。カメラを使ったAR処理を行います。
プロパティー arrowA 方向矢印の色(透過度α)0-255です。
arrowR 方向矢印の色(R成分)0-255です。
arrowG 方向矢印の色(G成分)0-255です。
arrowB 方向矢印の色(B成分)0-255です。
メソッド setCurrentPos: 現在位置の設定を行います。
addPOI: 位置情報を追加します。
removePOI: 指定した位置情報を削除します。
clearPOI: 位置情報をすべて削除します。
setDestination: 目的地を設定します。
setRoute: ルートの設定を行います。
YMKWeatherOverlay 雨雲レーダー情報の表示を行うOverlayクラスです。
メソッドー init YMKWeatherOverlay初期化用メソッドです。
YMKWeatherOverlayView 雨雲レーダー情報の表示を行うOverlayViewクラスです。
プロパティ nowDate 現在画面上に表示されている雨雲レーダー情報の日時を取得します。
delegate デリゲートを取得・設定します。
メソッドー initWithWeatherOverlay: YMKWeatherOverlayView初期化用メソッドです。
updateWeather 雨雲レーダー情報を最新のデータに更新します。
startAutoUpdateWithInterval: 指定した間隔で雨雲レーダー情報の自動更新を行ないます。
stopAutoUpdate 自動更新を停止します。
updateWeatherWithMinutes 最新データの時刻から指定した時間分の過去また未来の雨雲データを取得します。

プロトコル

プロトコル メソッド・属性 概要
YMKAnnotation 地図上に表示するアイコンのタイトル、サブタイトル、位置情報を設定するためのプロトコルです。
プロパティー coordinate YMKAnnotationの中心緯度経度プロパティー。
メソッド setCoordinate: YMKAnnotationの中心緯度経度を設定するメソッドです。
title: YMKAnnotationに設定されているタイトル文字列を返すメソッドです。
subtitle: YMKAnnotationに設定されているサブタイトル文字列を返すメソッドです。
YMKMapViewDelegate 地図オブジェクトから、さまざまな通知を受け取るためのプロトコルです。
メソッド mapView:
regionWillChangeAnimated:
地図の表示領域が変更されようとしているときに、デリゲートに通知されます。
mapView:
regionDidChangeAnimated:
地図の表示領域が変更されたことをデリゲートに通知されます。
mapViewWillStartLoadingMap: 地図データを取得しようとしているときに、デリゲートに通知されます。
mapViewDidFinishLoadingMap: 地図データの取得に成功したときに、デリゲートに通知されます。
mapViewDidFailLoadingMap:
withError:
地図データを取得できなかったときに、デリゲートに通知されます。
mapView:viewForAnnotation: YMKAnnotationが追加されたときに、デリゲートに通知されます。
mapView:annotationView:
calloutAccessory
ControlTapped:
YMKAnnotationの吹き出しのボタンが押されたときに、デリゲートに通知されます。
mapView:viewForOverlay: YMKOverlayが追加されたときに、デリゲートに通知されます。
mapViewWillStartLocatingUser: ユーザーの現在位置を追跡し始めたときにデリゲートに通知されます。
mapViewDidStopLocatingUser: ユーザー位置の追跡を終了したときにデリゲートに通知されます。
mapView:didUpdateUserLocation: ユーザーの位置がアップデートされたときにデリゲートに通知されます。
mapView:
didFailToLocateUserWithError:
ユーザーの位置がアップデートされなかったときにデリゲートに通知されます。
YMKOverlay 地図上に表示する図形の中心緯度経度、図形の制限長方形を設定します。
プロパティー coordinate 図形の中心緯度経度プロパティー。
boundingMapRect 図形の制限長方形プロパティー。
メソッド intersectsMapRect: 指定された長方形に図形が交差するかどうかを判定するメソッドです。
YMKLabelTouchDelegate 注記がタッチされた際に通知を受け取るためのプロトコルです。
メソッド onLabelTouchWithLabelInfo: 注記がタッチされた際にデリゲートに通知されます。
YMKRouteOverlay
Delegate
YMKRouteOverlayからのルート検索結果の通知を受け取るプロトコルクラスです。
メソッド finishRouteSearch: ルート検索が正常に終了した場合に呼ばれるメソッドです。
errorRouteSearch:withError ルート検索が正常に終了しなかった場合に呼ばれるメソッドです。
YMKRouteNodeInfo ルートの経由点情報を取得するためのプロトコルクラスです。
プロパティー direction 右左折情報を取得します。
distance 経由点間の距離をメートルで取得します。
time 経由点間の移動にかかる時間を分で取得します。
floorLevel 階層のプロパティーです。
YMKNaviControllerDelegate YMKNaviControllerからルート案内結果の通知を受け取るプロトコルクラスです。
メソッド naviController:
didUpdateUserLocation:
現在位置が更新された際にデリゲートに通知されます。
naviController:didFailTo
LocateUserWithError:
現在位置の取得に失敗したときにデリゲートに通知されます。
naviControllerAccuracyBad:
didUpdateUserLocation:
現在位置の精度が悪いと判断された場合にデリゲートに通知されます。
naviControllerRouteOut:
didUpdateUserLocation:
現在位置がルートから外れたと判断された場合にデリゲートに通知されます。
naviControllerOnGoal:
didUpdateUserLocation:
目的地に着いたと判断された場合にデリゲートに通知されます。
YMKNaviControllerDelegate YMKNaviControllerからルート案内結果の通知を受け取るプロトコルクラスです。
メソッド naviController:
didUpdateUserLocation:
現在位置が更新された際にデリゲートに通知されます。
naviController:didFailTo
LocateUserWithError:
現在位置の取得に失敗したときにデリゲートに通知されます。
naviControllerAccuracyBad:
didUpdateUserLocation:
現在位置の精度が悪いと判断された場合にデリゲートに通知されます。
naviControllerRouteOut:
didUpdateUserLocation:
現在位置がルートから外れたと判断された場合にデリゲートに通知されます。
naviControllerOnGoal:
didUpdateUserLocation:
目的地に着いたと判断された場合にデリゲートに通知されます。
YMKWeatherOverlayDelegate YMKWeatherOverlayViewから雨雲レーダー情報の更新通知を受け取るプロトコルクラスです。
メソッド finishUpdateWeather: 画面上の雨雲レーダー情報が正常更新された場合にデリゲートに通知されます。
errorUpdateWeather:
withError:
雨雲レーダー情報が正常に更新できなかった場合にデリゲートに通知されます。