コンテンツにスキップ

StandardImageProvider

画像プロバイダ

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

Example

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

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

See

Extends

Constructors

new StandardImageProvider()

new StandardImageProvider(data): StandardImageProvider

Parameters

Parameter Type
data Resource | ResourceInfo

Returns

StandardImageProvider

Overrides

ImageProvider.constructor

Methods

getAttributions()

getAttributions(): undefined | Attributions

Returns

undefined | Attributions

Inherited from

ImageProvider.getAttributions


getInfo()

getInfo(): Required<Info>

Returns

Required<Info>

Inherited from

ImageProvider.getInfo


init()

init(): Promise<Required<Info>>

初期化を行う

Returns

Promise<Required<Info>>

Inherited from

ImageProvider.init

See

ImageProvider.Hook.init


isReady()

isReady(): boolean

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

Returns

boolean

Inherited from

ImageProvider.isReady


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>

Inherited from

ImageProvider.requestTile

See

ImageProvider.Hook.requestTile