コンテンツにスキップ

Hook

Methods

init()

init(options?): Promise<Info>

タイルプロバイダを初期化しリクエストできる状態にする。 また、このプロバイダが持つプロパティについても、この関数に成功した時点でアクセス可能になる。

リクエストできる状態に遷移できなかった場合は必ず例外をスローしなければならない。

Parameters

Parameter Type
options? object
options.signal? AbortSignal

Returns

Promise<Info>


requestTile()

requestTile(z, x, y, options?): Promise<ArrayBuffer>

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

座標が (z, x, y) のタイルデータを要求する。

だたし [[cancelRequest]] により要求が取り消されたとき、callback は呼び出しても呼び出さなくてもよい。 また非同期呼び出しである必要もない。callback によって得たデータに値を上書きしてはならない。

Parameters

Parameter Type Description
z number ズームレベル
x number X タイル座標
y number Y タイル座標
options? object -
options.signal? AbortSignal -

Returns

Promise<ArrayBuffer>

リクエストオブジェクト