JAXA Earth API for JavaScript
    検索インデックスを準備しています...

    クラス ImageGenerator

    WMS (Web Map Service) 方式のパラメータを使用して画像を作成します。 OpenLayersImageCanvasなどを使用して地図APIと連携する場合に使用します。

    インデックス

    コンストラクター

    • パラメータ

      • __namedParameters: {
            collectionUrl: string;
            date?: Date;
            band?: string;
            resampling?: Resampling;
            colorMapObject?: ColorMapObject;
        }
        • collectionUrl: string

          データセットのcollection.jsonのURLです。

        • オプションdate?: Date

          取得するデータの日時です。省略した場合は現在の日時new Date()が指定されたものとして動作します。

        • オプションband?: string

          利用するデータセットのバンドです。省略した場合はそのデータセットに含まれる1件目(collection.json内で定義される順番で1件目)のバンドを利用します。

        • オプションresampling?: Resampling

          使用するリサンプリング方法です。省略した場合はニアレストネイバー(je.Resampling.NEAREST)が指定されたものとして動作します。

        • オプションcolorMapObject?: ColorMapObject

          可視化するためのカラーマップの条件です。省略した場合は{min: 0, max: 255, colors: ["000000", "ffffff"]}を指定したものとして動作します。 カラー画像やクラス分類型のデータ(photometricInterpretation == 1ではないデータ)の場合は無視され、各データで元から指定されている色が優先されます。 ウェブワーカーなど、スレッド間で描画条件を送受信する際に支障が無いように、ColorMapではなくColorMapObjectとしています。

      戻り値 ImageGenerator

    メソッド

    • 初期化します。実行必須です。

      戻り値 Promise<void>

    • HTMLCanvasElementとして画像を取得します。

      パラメータ

      • width: number

        画像の幅(ピクセル数)です。

      • height: number

        画像の高さ(ピクセル数)です。

      • extent: Bbox

        表示する地理範囲を示すBboxです。投影法projectionがEPSG:4326の場合は緯度経度で指定されますが、EPSG:3857の場合はm単位で指定されるものとなります。WMSのパラメータのルールに依存することに注意が必要です。

      • projection: Projection

        使用する投影法です。

      • callback: (progress: number, canvas: HTMLCanvasElement, dataObject: DataObject) => void

        データが読み込まれるたびに実行されるコールバック関数です。進捗率(0~100)や読み込み途中の画像を取得できます。

      • abortSignal: AbortSignal

      戻り値 Promise<HTMLCanvasElement>

      ブラウザのメインスレッドでのみ利用可能です。

    • OffscreenCanvasとして画像を取得します。

      パラメータ

      • width: number

        画像の幅(ピクセル数)です。

      • height: number

        画像の高さ(ピクセル数)です。

      • extent: Bbox

        表示する地理範囲を示すBboxです。投影法projectionがEPSG:4326の場合は緯度経度で指定されますが、EPSG:3857の場合はm単位で指定されるものとなります。WMSのパラメータのルールに依存することに注意が必要です。

      • projection: Projection

        使用する投影法です。

      • callback: (
            progress: number,
            offscreenCanvas: OffscreenCanvas,
            dataObject: DataObject,
        ) => void

        データが読み込まれるたびに実行されるコールバック関数です。進捗率(0~100)や読み込み途中の画像を取得できます。

      • abortSignal: AbortSignal

      戻り値 Promise<OffscreenCanvas>

      ブラウザのメインスレッドまたはウェブワーカーでのみ利用可能です。

    • PNG画像のUint8Arrayとして画像を取得します。

      パラメータ

      • width: number

        画像の幅(ピクセル数)です。

      • height: number

        画像の高さ(ピクセル数)です。

      • extent: Bbox

        表示する地理範囲を示すBboxです。投影法projectionがEPSG:4326の場合は緯度経度で指定されますが、EPSG:3857の場合はm単位で指定されるものとなります。WMSのパラメータのルールに依存することに注意が必要です。

      • projection: Projection

        使用する投影法です。

      • callback: (progress: number, pngUint8Array: Uint8Array, dataObject: DataObject) => void

        データが読み込まれるたびに実行されるコールバック関数です。進捗率(0~100)や読み込み途中の画像を取得できます。

      • abortSignal: AbortSignal

      戻り値 Promise<Uint8Array<ArrayBufferLike>>

    • カラーマップを途中で変更する場合に使用します。

      パラメータ

      戻り値 void

    • すでに読み込まれているDataObjectをキャッシュから再度取得します。再度通信は行われません。

      戻り値 DataObject