UserWidget

ユーザーウィジェットのクラス

Constructor

new ZDC.UserWidget(latlng, options)

ユーザーウィジェットを作成します。
zIndex(重なり順)のdefault値はauto。

Parameters

名前 説明
latlng
LatLng 		表示位置の緯度経度
指定した緯度経度がユーザーウィジェットの左上の緯度経度になります。
options(optional)
Object
default {}		 オプション設定
名前 説明
htmlSource(optional)
string
default ''		 HTMLのソースコード
offset(optional)
Point
default null		 吹き出し表示のオフセット値
指定したPointのピクセル分移動します。
x軸は右が正、y軸は下が正となります。
例)Point(100,100)を指定した場合、右方向100,下方向100の位置に移動します。
rotatedView(optional)
integer
default 0		 表示回転角度
保持する座標値は変えずに、地図上の見栄えを図形のBBOXを中心に指定角度回転させます。
左回りを正とします。
propagation(optional)
boolean
default false		 イベントの地図伝搬フラグ
このウィジェット上で起きたイベントをMapにも伝搬させます。
  • true

    Mapのイベントが発生する

  • false

    Mapのイベントが発生しない

Example

// インスタンスを作成
var widget = new ZDC.UserWidget(
  map.getCenter(),
  { htmlSource: '<div style="background-color: #FFFFFF"><b>Sample UserWidget</b></div>',
    offset: new ZDC.Point(100, 100) // 右方向100,下方向100の位置に移動。
  }
);
// UserWidgetをMapに追加
map.addWidget(widget);

Methods

getLatLng()

表示位置を取得します。

Returns
Type:LatLng
表示位置を返却します。
setLatLng(latlng)

表示位置を設定します。

Parameters
latlng(LatLng)
表示位置
show()

表示します。

hide()

非表示にすることができます。

setZIndex(zIndex)

重なりの順序を設定します。値が同一のウィジェットとの重なり順は保証されません。

ウィジェットクラス間でのみ有効です。図形との重なり順序は保証されません。
図形クラス:Polygon,Polyline,Oval,GroundOverlay,ImageLayer,GLLabel
ウィジェットクラス:Popup,Marker,UserWidget,MarkerCluster,StataicUserWidget

Parameters
zIndex(number)
重なり順
大きい数字であれば手前、小さい場合は奥に配置されます。
Throws
zIndexが0以下の場合、エラーとなります。
Example
// 奥のレイヤー
lowerGroundOverlay.setZIndex(101);
// 手前のレイヤー
upperGroundOverlay.setZIndex(102);
setOptions(options)

オプションを設定します。

Parameters
options(Object)
オプション設定。constructorのoptionsと同じ。
addEventListener(eventName, listener)

イベントリスナーを登録します。

Parameters
eventName(string)
イベントの種類を表す文字列。
Map Eventsを参照(マウス操作イベントとタッチ操作イベントのみ対応)
listener(function)
登録するイベントリスナー。
イベントリスナーの引数は、HTML DOM要素 addEventListenerメソッドのlistenerに渡されるオブジェクトと同様のオブジェクトが引数として渡されます。
Example
// インスタンスを作成
var widget = new ZDC.UserWidget(
  map.getCenter(),
  { htmlSource: '<div style="background-color: #FFFFFF"><b>Sample UserWidget</b></div>',
    offset: new ZDC.Point(100, 100) // 右方向100,下方向100の位置に移動。
  }
);
// クリックイベント登録
widget.addEventListener('click', function(event) {
  // 処理
  alert("Sample Event!");
});
// UserWidgetをMapに追加
map.addWidget(widget);
removeEventListener(eventName, listener)

登録したイベントリスナーを削除します。

Parameters
eventName(string)
イベントの種類を表す文字列
MapのMap Eventsを参照
(マウス操作イベントとタッチ操作イベントのみ対応)
listener(function)
削除するイベントリスナー
getId()

idを取得します。

Returns
Type:string
idを返却します。