YOLP(地図)

Controlクラス

Control クラス

クラス一覧へ

Class Control

UIコントロール

Class Summary

属性 クラス名と説明
 
地図の上に配置されるUIコントロールなどを実装するためのインターフェースです。このインターフェースを実装したカスタムコントロールは、Map.addControl()メソッドを使用して地図上に追加されます。

Method Summary

属性 メソッド名と説明
 
コントロールが地図上に表示されるときのデフォルト位置を返します。これはMap.addControl()の2番目の引数が設定されているときには、そちらが優先されるため使用されません。
 
hide()
表示中のコントロールを非表示にします
 
コントロールの初期化処理を実装します。この処理は、Map.addControl()から呼び出されます。地図の上に配置するDOMノードを生成し戻り値として返すと、地図の上に配置されます。
 
コントロールが現在表示中であるかを返します
 
コントロールが印刷可能であるかどうかを返します。
 
show()
非表示にされているコントロールを表示します

Class Detail

  • Control()
    地図の上に配置されるUIコントロールなどを実装するためのインターフェースです。 このインターフェースを実装したカスタムコントロールは、Map.addControl()メソッドを使用して地図上に追加されます。

Method Detail

  • {ControlPosition}getDefaultPosition()
    コントロールが地図上に表示されるときのデフォルト位置を返します。 これはMap.addControl()の2番目の引数が設定されているときには、そちらが優先されるため使用されません。
    Returns:
    {ControlPosition}
  • hide()
    表示中のコントロールを非表示にします
  • {Node}initialize(map)
    コントロールの初期化処理を実装します。 この処理は、Map.addControl()から呼び出されます。 地図の上に配置するDOMノードを生成し戻り値として返すと、地図の上に配置されます。
    Parameters:
    {Map} map
    追加先の地図
    Returns:
    {Node} node 生成したDOMノード
  • {Boolean}isVisible()
    コントロールが現在表示中であるかを返します
    Returns:
    {Boolean}
  • printable()
    コントロールが印刷可能であるかどうかを返します。
  • show()
    非表示にされているコントロールを表示します

Class ControlPosition

コントロール位置

Class Summary

属性 クラス名と説明
 
ControlPosition(anchor, offset)
地図上でのコントロール位置を表します。

Field Summary

属性 フィールド名と説明
<static> <constant>  
ControlPosition.BOTTOM_LEFT
コントロールを地図の左下に配置します。
<static> <constant>  
ControlPosition.BOTTOM_RIGHT
コントロールを地図の右下に配置します。
<static> <constant>  
ControlPosition.TOP_LEFT
コントロールを地図の左上に配置します。
<static> <constant>  
ControlPosition.TOP_RIGHT
コントロールを地図の右上に配置します。

Class Detail

  • ControlPosition(anchor, offset)
    地図上でのコントロール位置を表します。
Parameters:
{String} anchor
コントロールの固定位置
{Size} offset
固定位置からのオフセット

Field Detail

  • <static> <constant> {String}ControlPosition.BOTTOM_LEFT
    コントロールを地図の左下に配置します。
  • <static> <constant> {String}ControlPosition.BOTTOM_RIGHT
    コントロールを地図の右下に配置します。
  • <static> <constant> {String}ControlPosition.TOP_LEFT
    コントロールを地図の左上に配置します。
  • <static> <constant> {String}ControlPosition.TOP_RIGHT
    コントロールを地図の右上に配置します。

Class CenterMarkControl

中心点表示コントロール

Class Summary

属性 クラス名と説明
 
地図中心点を表示します。

Method Summary

属性 メソッド名と説明
 
中心点の表示状態を返します。

Class Detail

  • CenterMarkControl(options)
    地図中心点を表示します。
Parameters:
{Object} options
オプション
{Boolean} visible
中心点を表示します。デフォルト値はtrueです。
{Boolean} visibleButton
中心点の表示を切り替えるボタンを表示します。デフォルト値はfalseです。

Method Detail

  • {Boolean}isVisibleCenterMark()
    中心点の表示状態を返します。
Returns:
{Boolean} visible 表示状態

Class LayerSetControl

レイヤーセット切り替えコントロール

Class Summary

属性 クラス名と説明
 
レイヤーセットを切り替えるコントロールを作成します。

Method Summary

属性 メソッド名と説明
 
オーバーレイレイヤーボタンの表示/非表示を切り替えます。

Class Detail

  • LayerSetControl(options)
    レイヤーセットを切り替えるコントロールを作成します。
Parameters:
{Object} options
オプション
{Boolean} enableOverlayButton
オーバーレイレイヤー表示を切り替えるボタンを表示します。デフォルト値はtrueです。
{Point} offsetOverlayButton
オーバーレイレイヤーボタンの表示位置を調整します。 レイヤーセットコントロール表示位置からのオフセット値を設定します。 デフォルト値はY.Point(0, 0)です。

Method Detail

  • setEnableOverlayButton(enable)
    オーバーレイレイヤーボタンの表示/非表示を切り替えます。
Parameters:
{Boolean} enable
true...表示 false...非表示

Class ScaleControl

縮尺コントロール

Class Summary

属性 クラス名と説明
 
ScaleControl(options)
地図の縮尺を表示するコントロールを作成します。コンテナ上の右側(ControlPosition.XXX_RIGHT)に配置されることを想定して描画されます。

Method Summary

属性 メソッド名と説明
 
縮尺コントロールのデフォルト位置を返します。
 
load(map, position)
コントロールの初期化処理を行ないます。
 
縮尺コントロールを削除します。

Class Detail

  • ScaleControl(options)
    地図の縮尺を表示するコントロールを作成します。 コンテナ上の右側(ControlPosition.XXX_RIGHT)に配置されることを想定して描画されます。
Parameters:
{Object} options
オプション

Method Detail

  • {ControlPosition}getDefaultPosition()
    縮尺コントロールのデフォルト位置を返します。
    Returns:
    {ControlPosition} デフォルト位置(右下)
  • load(map, position)
    コントロールの初期化処理を行ないます。
    Parameters:
    map
    position
  • remove()
    縮尺コントロールを削除します。

Class ZoomControl

ズームコントロール

Class Summary

属性 クラス名と説明
 
地図のズームを変更するシンプルなコントロールを作成します。

Class Detail

  • ZoomControl()
    地図のズームを変更するシンプルなコントロールを作成します。

Class HomeControl

ホームアイコンコントロール

Class Summary

属性 クラス名と説明
 
ホームアイコンを表示するコントロールを作成します。

Field Summary

属性 フィールド名と説明
 
ホームアイコンの表示状態を取得します。

Method Summary

属性 メソッド名と説明
 
ホームアイコンの場所を取得します。
 
ホームアイコンの位置に戻ります。
 
コントロールを削除します。

Class Detail

  • HomeControl()
    ホームアイコンを表示するコントロールを作成します。

Field Detail

  • isVisibleHomeIcon
    ホームアイコンの表示状態を取得します。

Method Detail

  • getLatLng()
    ホームアイコンの場所を取得します。
  • panToHome()
    ホームアイコンの位置に戻ります。
  • remove()
    コントロールを削除します。

Class SliderZoomControlVertical

スライダーズームコントロール(縦)

Class Summary

属性 クラス名と説明
 
垂直方向のスライダー形式の地図ズーム機能を提供します。

Class Detail

  • SliderZoomControlVertical(options)
    垂直方向のスライダー形式の地図ズーム機能を提供します。
Parameters:
{Object} options
オプション

Class SliderZoomControlHorizontal

スライダーズームコントロール(横)

Class Summary

属性 クラス名と説明
 
水平方向のスライダー形式の地図ズーム機能を提供します。

Class Detail

  • SliderZoomControlHorizontal(options)
    水平方向のスライダー形式の地図ズーム機能を提供します。
Parameters:
{Object} options
オプション

Class AddressCategoryControl

住所カテゴリコントロール

Class Summary

属性 クラス名と説明
 
住所をカテゴリ形式で表示する機能を提供します。

Method Summary

属性 メソッド名と説明
 
コントロールを削除します。

Class Detail

  • AddressCategoryControl(options)
    住所をカテゴリ形式で表示する機能を提供します。
Parameters:
{Object} options
オプション

Method Detail

  • remove()
    コントロールを削除します。