コンテンツにスキップ

ImageProvider

画像プロバイダ

レンダラーにラスターデータを与えるためのクラスです。 コンストラクタの引数によって実際の処理が決定されます。 独自の画像プロバイダを作成する際は、通常このクラスを直接継承するのではなく ImageProvider.Hook を用いる方法で行います。

Example

viewer.setImageProvider(new ImageProvider({
    init: () => {
        ...
    },
    requestTile: () => {
        ...
    },
}));

Hookの定義方法の詳細は ImageProvider.Hook を参照してください。

See

Extended by

Constructors

new ImageProvider()

new ImageProvider(hook): ImageProvider

引数により与えるフックにより、このプロバイダの動作(初期化処理や読み込み処理)が決定する。

Parameters

Parameter Type Description
hook Hook 画像プロバイダの動作を決定するフック

Returns

ImageProvider

Methods

getAttributions()

getAttributions(): undefined | Attributions

Returns

undefined | Attributions


getInfo()

getInfo(): Required<Info>

Returns

Required<Info>


init()

init(): Promise<Required<Info>>

初期化を行う

Returns

Promise<Required<Info>>

See

ImageProvider.Hook.init


isReady()

isReady(): boolean

タイル画像をリクエストできる状態である場合は true を返す。

Returns

boolean


requestTile()

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

タイル画像をリクエストする

2回以上呼ばれた場合は、処理をスキップし初回と同様の値を返却する。

Parameters

Parameter Type Description
z number タイルのZ
x number タイルのX
y number タイルのY
options? object -
options.signal? AbortSignal リクエストキャンセル用のシグナル

Returns

Promise<SupportedImageTypes>

See

ImageProvider.Hook.requestTile