Class: ImageProvider

Classes

Range

地図画像ズームレベル範囲

Members

---

<static, constant> Status :object

ImageProvider 状態の列挙型

Type:

• object

Properties:

Name	Type	Default	Description
NOT_READY	object	{"id":"NOT_READY"}	準備中
READY	object	{"id":"READY"}	準備完了
FAILED	object	{"id":"FAILED"}	失敗状態

Source:

• ImageProvider.js, line 167

See:

• mapray.ImageProvider#status

Methods

---

<abstract> cancelRequest(id)

地図タイル画像の要求を取り消す

requestTile() による要求を可能であれば取り消す。

Parameters:

Name	Type	Description
id	object	要求 ID (requestTile() から得たオブジェクト)

Source:

• ImageProvider.js, line 72

---

<abstract> getImageSize()

地図タイル画像の寸法を取得

サーバーが提供する地図タイル画像の寸法をする。

地図タイル画像は正方形を前提とし、水平方向の画素数を返す。

制限: this が同じなら常に同じ値を返さなければならない。

Source:

• ImageProvider.js, line 87

Returns:

地図タイル画像の画素数

Type

number

---

<abstract> getZoomLevelRange()

地図画像ズームレベルの範囲を取得

サーバーが提供する地図タイル画像のズームレベルの範囲を取得する。

制限: this が同じなら常に同じ範囲を返さなければならない。

Source:

• ImageProvider.js, line 101

Returns:

ズームレベルの範囲

Type

mapray.ImageProvider.Range

---

<abstract> requestTile(z, x, y, callback)

地図タイル画像を要求

座標が (z, x, y) の地図タイル画像を要求する。

指定したタイル画像の取得が成功または失敗したときに callback が非同期に呼び出されなければならない。

だたし cancelRequest() により要求が取り消されたとき、callback は呼び出しても呼び出さなくてもよい。また非同期呼び出しである必要もない。

Parameters:

Name	Type	Description
z	number	ズームレベル
x	number	X タイル座標
y	number	Y タイル座標
callback	mapray.ImageProvider.RequestCallback	要求コールバック関数

Source:

• ImageProvider.js, line 60

Returns:

要求 ID (cancelRequest() に与えるオブジェクト)

Type

object

---

<abstract> status( [callback])

状態の取得

現在の ImageProvider 状態を返す。

callback を与えたとき、状態が NOT_READY から READY または FAILED に変化したときに callback が呼び出される。 NOT_READY 以外の状態で callback 与えても、それは無視されコールバック関数は登録されない。

Parameters:

Name	Type	Argument	Description
callback	mapray.ImageProvider.StatusCallback	<optional>	状態変化コールバック関数

Source:

• ImageProvider.js, line 41

Returns:

現在の ImageProvider 状態

Type

mapray.ImageProvider.Status

Type Definitions

---

RequestCallback(image)

地図タイル画像要求コールバック関数型

地図タイル画像の取得に成功または失敗したときに呼び出される関数の型である。

この関数は requestTile() の callback 引数に与える。

画像の取得に成功したときは、image に Image のインスタンス、失敗したときは null を与える。

ただし cancelRequest() により要求が取り消されたとき、コールバック関数の呼び出しは無視されるので image は任意の値でよい。

Parameters:

Name	Type	Description
image	Image	地図タイル画像または null

Source:

• ImageProvider.js, line 147

---

StatusCallback(status)

状態変化コールバック関数型

Parameters:

Name	Type	Description
status	mapray.ImageProvider.Status	READY または FAILED (NOT_READEY から遷移した状態)

Source:

• ImageProvider.js, line 189