GroundOverlay

画像図形のクラス

Constructor

new ZDC.GroundOverlay(bounds, imageUrl, optionsopt)

画像図形を作成します。
zIndex(重なり順)のdefault値は100。

Parameters

名前 説明
bounds
LatLngBounds 		表示領域の矩形(縦横が経線・緯線と平行な矩形)
imageUrl
string		 画像のURL
絶対パスで指定してください。
options(optional)
Object
default {}		 オプション設定
名前 説明
opacity(optional)
number
default 1.0		 不透明度
0.0～1.0の実数指定
0
透明
1
不透明
rotatedView(optional)
integer
default 0		 表示回転角度
保持する座標値は変えずに、地図上の見栄えを図形のBBOXを中心に指定角度回転させます。
左回りを正とします。
draw(optional)
string
default 'high'		 アンダーレイ描画オプション
  • 'high'

    背景図の上

  • 'middle'

    背景図の注記と図形の間

  • 'low'

    背景図の下
propagation(optional)
boolean
default false 		イベントの地図伝搬フラグ
このウィジェット上で起きたイベントをMapにも伝搬させます。
  • true

    Mapのイベントが発生する

  • false

    Mapのイベントが発生しない
requestHeader
Object
default null 		リクエストヘッダ
画像リクエスト時に付与するリクエストヘッダをオブジェクトで指定します。
指定したオブジェクトのkey:valueの内容を、リクエスト時にHTTPヘッダとして送信します。

※オブジェクトのkey,valueともに、String型の指定のみ可能
※JavaScriptAPIの処理内で以下処理を行う
・指定された文字列はISO-8859-1で構成されたものとして扱う
・文字数の制限や接頭辞付与は行わず、指定された文字列をそのままリクエストヘッダとして送信する
・リクエストの事前に、ブラウザによるCORSのPreflightリクエストを行う
※リクエスト先の画像配信サーバーでは上記仕様を前提としたCORSのPreflightリクエストへの応答が必要

指定例）
{ "key": "value", "foo": "bar" }

Example

// 南西の座標(世界測地系を指定)
var southWest = new ZDC.LatLng('35.677881', '139.763630');
// 北東の座標(世界測地系を指定)
var nothernEast = new ZDC.LatLng('35.683946', '139.771054');
// 表示領域
var latLngBounds = new ZDC.LatLngBounds(southWest, nothernEast);
// インスタンスを生成
var groundOverlay = new ZDC.GroundOverlay(latLngBounds, 'https://XXXXXX.com/files/parts/top_text/ico_search.png', {opacity:0.5, propagation:true});

// GroundOverlayをMapに追加
map.addWidget(groundOverlay);

Methods

getBounds()

画像の表示領域を取得します。

Returns
Type:LatLngBounds
表示領域の矩形を返却します。
setBounds(bounds)

画像の表示領域を設定します。

Parameters
bounds(LatLngBounds)
表示領域の矩形(縦横が経線・緯線と平行な矩形)
setImageUrl(imageUrl)

画像のURLを設定します。

Parameters
imageUrl(string)
画像のURL(絶対パスで指定してください。)
setZIndex(zIndex)

重なりの順序を設定します。値が同一の図形との重なり順は保証されません。

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

Parameters
zIndex(number) default 100
重なり順
大きい数字であれば手前、小さい場合は奥に配置されます。
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)
登録するイベントリスナー。
イベントリスナーの引数はMap Eventsを参照して下さい。
Example
groundOverlay.addEventListener('click', function(type, latLng, point) {
	// 処理
});
removeEventListener(eventName, listener)

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

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

idを取得します。

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

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

show()

表示します。