コンテンツにスキップ

Hook

標準地図画像プロバイダ

汎用的な地図画像プロバイダの実装である。 構築子の引数に 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 ) を返す

Implements

Constructors

new Hook()

new Hook(resourceInfo): Hook

Parameters

Parameter Type Description
resourceInfo ResourceInfo リソースオプション

Returns

Hook

new Hook()

new Hook(resource): Hook

Parameters

Parameter Type Description
resource Resource リソースオブジェクト

Returns

Hook

Methods

getBounds()

getBounds(): GeoRegion

Returns

GeoRegion


getImageSize()

getImageSize(): number

Returns

number

Inherit Doc


getPixelFormat()

getPixelFormat(): ColorPixelFormat | HeightmapPixelFormat

Returns

ColorPixelFormat | HeightmapPixelFormat

Inherit Doc


getZoomLevelRange()

getZoomLevelRange(): Range

Returns

Range

Inherit Doc


init()

init(): Promise<Info>

タイルプロバイダを初期化しリクエストできる状態にします。

  • リクエストできる状態に遷移できなかった場合は必ず例外をスローします
  • この関数は2回以上呼ばれることはありません

Returns

Promise<Info>

タイルプロバイダの情報

Implementation of

Hook.init


requestTile()

requestTile(z, x, y): Promise<SupportedImageTypes>

タイルをリクエストします。

座標が (z, x, y) のタイルデータを要求します。 Hook.init の呼び出しに成功した場合に、レンダラが必要なタイミングで何度も呼び出します。

Parameters

Parameter Type Description
z number ズームレベル
x number X タイル座標
y number Y タイル座標

Returns

Promise<SupportedImageTypes>

リクエスト結果

Implementation of

Hook.requestTile