DOCS
References

Class: StandardImageProvider

mapray~ StandardImageProvider

汎用的な地図画像プロバイダの実装である。

構築子の引数に prefix, suffix, size, zmin, zmax を与えた場合、各メソッドの動作は以下のようになる。 ここで c1, c2, c3 は opts.coord_order の指定に従った第1、第2、第3の座標である。

  requestTile( z, x, y ) -> URL が prefix + c1 + '/' + c2 + '/' + c3 + suffix の画像を要求
  getImageSize()         -> size を返す
  getZoomLevelRange()    -> new ImageProvider.Range( zmin, zmax ) を返す

new StandardImageProvider(prefix, suffix, size, zmin, zmax [, opts])

標準地図画像プロバイダ

Parameters:
Name Type Argument Description
prefix string

URL の先頭文字列
suffix string

URL の末尾文字列
size number

地図タイル画像の寸法
zmin number

最小ズームレベル
zmax number

最大ズームレベル
opts object <optional>

オプション集合

Properties
Name Type Argument Default Description
coord_order mapray.StandardImageProvider.CoordOrder <optional>
 ZXY

URL の座標順序
coord_system mapray.StandardImageProvider.CoordSystem <optional>
 UPPER_LEFT

タイル XY 座標系
credentials mapray.CredentialMode <optional>
 SAME_ORIGIN

クレデンシャルモード
Source:

Extends

Members

<static, constant> CoordOrder :object

URL 座標順序の列挙型

mapray.StandardImageProvider の構築子で opts.coord_order パラメータに指定する値の型である。

Type:
  • object
Properties:
Name Type Default Description
ZXY object {"id":"ZXY"}

座標順序 Z/X/Y (既定値)
ZYX object {"id":"ZYX"}

座標順序 Z/Y/X
XYZ object {"id":"XYZ"}

座標順序 Z/X/Y
Source:

<static, constant> CoordSystem :object

タイル XY 座標系の列挙型

mapray.StandardImageProvider の構築子で opts.coord_system パラメータに指定する値の型である。

Type:
  • object
Properties:
Name Type Default Description
UPPER_LEFT object {"id":"UPPER_LEFT"}

原点:左上, X軸:右方向, Y軸:下方向 (既定値)
LOWER_LEFT object {"id":"LOWER_LEFT"}

原点:左下, X軸:右方向, Y軸:上方向
Source:

Methods

cancelRequest(id)

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

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

Parameters:
Name Type Description
id object

要求 ID (requestTile() から得たオブジェクト)
Inherited From:
Overrides:
Source:

getImageSize()

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

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

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

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

Inherited From:
Overrides:
Source:
Returns:

地図タイル画像の画素数

Type
number

getZoomLevelRange()

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

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

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

Inherited From:
Overrides:
Source:
Returns:

ズームレベルの範囲

Type
mapray.ImageProvider.Range

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

要求コールバック関数
Inherited From:
Overrides:
Source:
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>

状態変化コールバック関数
Inherited From:
Overrides:
Source:
Returns:

現在の ImageProvider 状態

Type
mapray.ImageProvider.Status