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

    クラス TileGenerator

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

    インデックス

    コンストラクター

    • パラメータ

      • __namedParameters: {
            collectionUrl: string;
            date?: Date;
            band?: string;
            resampling?: Resampling;
            colorMapObject?: ColorMapObject;
            tileSize?: number;
            delay?: number;
        }
        • 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としています。

        • オプションtileSize?: number

          作成するタイルのサイズ(幅・高さのピクセル数)です。256か512で動作確認済みです。指定しない場合は256が指定されたものとして動作します。

        • オプションdelay?: number

          この時間[ミリ秒]ごとにまとめてタイルを取得します。指定しない場合は500が指定されたものとして動作します。 この値を大きくすると、この時間内に届く複数のタイル描画指示を集約してデータをまとめて取得するため通信を効率化できますが、結果が返るまでの時間が長くなります。

      戻り値 TileGenerator

    メソッド

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

      戻り値 Promise<void>

    • DataObjectとしてタイルのデータを取得します。

      パラメータ

      • x: number

        タイル座標Xです。

      • y: number

        タイル座標Yです。

      • z: number

        タイル座標Zです。

      • オプションabortSignal: AbortSignal

        中断処理するためのAbortSignalを渡します。

      戻り値 Promise<DataObject>

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

      パラメータ

      • x: number

        タイル座標Xです。

      • y: number

        タイル座標Yです。

      • z: number

        タイル座標Zです。

      • オプションabortSignal: AbortSignal

        中断処理するためのAbortSignalを渡します。

      戻り値 Promise<HTMLCanvasElement>

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

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

      パラメータ

      • x: number

        タイル座標Xです。

      • y: number

        タイル座標Yです。

      • z: number

        タイル座標Zです。

      • オプションabortSignal: AbortSignal

        中断処理するためのAbortSignalを渡します。

      戻り値 Promise<OffscreenCanvas>

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

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

      パラメータ

      • x: number

        タイル座標Xです。

      • y: number

        タイル座標Yです。

      • z: number

        タイル座標Zです。

      • オプションabortSignal: AbortSignal

        中断処理するためのAbortSignalを渡します。

      戻り値 Promise<Uint8Array<ArrayBufferLike>>

    • パラメータ

      戻り値 void