Constructor
new Image(params)
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
params |
Object | Imageインスタンスを取得するための条件です。
Properties
|
- See:
Methods
deleteData()
初期化の実行結果を削除します。データ取得のためには再度Image#initの実行が必要です。
getBand() → {string}
Imageインスタンス内で使用中のBand名を取得します。
Returns:
Band名です。
- Type
- string
getBbox() → {BboxObject}
取得する画像の緯度経度範囲を取得します。
Returns:
緯度経度範囲を表すBboxObjectです。
- Type
- BboxObject
getCanvas() → {HTMLCanvasElement}
データを可視化した結果をcanvas要素(HTMLCanvasElement)として返します。
document.body.appendChildなどを用いることで、ブラウザ上に表示できます。
また、HTMLのimgタグを利用して画像を表示させたい場合は、HTMLCanvasElementのtoDataURL()で得られるDataURL形式の画像をimgタグのsrc属性に設定します。
Returns:
可視化結果を画像としてブラウザ上に表示するためのHTMLCanvasElementです。
- Type
- HTMLCanvasElement
getColorMap() → {ColorMapObject}
画像を画像化する際に使用するカラーマップを取得します。
Returns:
カラーマップを表すColorMapObjectです。
- Type
- ColorMapObject
getCoordinates(i, j) → {Object}
取得画像内の場所(i, j)の緯度経度を取得します。
Parameters:
| Name | Type | Description |
|---|---|---|
i |
number | 横方向のピクセル位置です。左端がi=0、右端がi=widthです。 |
j |
number | 縦方向のピクセル位置です。上端がj=0、下端がj=heightです。 |
Returns:
緯度経度の値を返します。
- Type
- Object
getData() → {DataObject}
データを返します。画像の幅や高さ、各ピクセルの値などのデータを含みます。
Returns:
- Type
- DataObject
getDate() → {Date}
日時を返します。
Returns:
日時を表すDateです。
- Type
- Date
getFormattedDate() → {string}
データセット（各collection.jsonのje:stac_date_format）で定義されている日時形式に基づいて、日時文字列を返します。例えば月単位のデータセットの場合はYYYY/MM形式、日付単位のデータセットの場合はYYYY/MM/DD形式で返します。
Returns:
日時の文字列です。
- Type
- string
getHeight() → {number}
取得する画像の高さ(ピクセル数)を取得します。
Returns:
高さのピクセル数です。
- Type
- number
getImageCollection() → {ImageCollection}
Imageインスタンス内で使用中のImageCollectionを取得します。
Returns:
- Type
- ImageCollection
getLegend(width, height, fontSize) → {HTMLCanvasElement}
カラーマップの凡例画像をcanvasとして返します。
Parameters:
| Name | Type | Description |
|---|---|---|
width |
number | 凡例画像の幅(ピクセル数)です。 |
height |
number | 凡例画像の高さ(ピクセル数)です。 |
fontSize |
number | 凡例画像内の文字サイズ(ピクセル数)です。 |
Returns:
カラーマップの凡例を画像としてブラウザ上に表示するためのHTMLCanvasElementです。
- Type
- HTMLCanvasElement
getMax() → {number}
データの中で最も大きな値を持つピクセルの値を取得します。
Returns:
最大値です。
- Type
- number
getMin() → {number}
データの中で最も小さな値を持つピクセルの値を取得します。
Returns:
最小値です。
- Type
- number
getStacItems() → {Array}
データの取得で使用されたSTAC Itemを返します。
Returns:
STAC Itemのリストです。
- Type
- Array
getTid() → {string}
データの取得で使用されたSTACの時刻IDを返します。
Returns:
STACの時刻IDです。
- Type
- string
getUnit() → {string}
データの単位を取得します。FeatureのSTAC中で定義されるje:rastersのunitの値です。
Returns:
単位の文字列を返します。
- Type
- string
getValue(i, j) → {number}
取得画像内の場所(i, j)における値を取得します。
Parameters:
| Name | Type | Description |
|---|---|---|
i |
number | 横方向のピクセル位置です。左端がi=0、右端がi=widthです。 |
j |
number | 縦方向のピクセル位置です。上端がj=0、下端がj=heightです。 |
Returns:
データの値を返します。
- Type
- number
getWidth() → {number}
取得する画像の幅(ピクセル数)を取得します。
Returns:
幅のピクセル数です。
- Type
- number
(async) init(onloadingopt, projectionopt)
初期化します。この中でデータが取得されるため、必ず実行が必要です。
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
onloading |
Image~Image-onloading |
<optional> |
function(){} | データを取得している最中に実行されるコールバック関数です。COGファイルのタイル単位でデータが読み込まれるたびに実行されます。 |
projection |
string |
<optional> |
投影法です。 |
ready() → {boolean}
初期化の実行状況を取得します。
Returns:
- Type
- boolean
setBbox(bbox)
取得する画像の緯度経度範囲を指定します。
Parameters:
| Name | Type | Description |
|---|---|---|
bbox |
BboxObject | 緯度経度範囲を表すBboxObjectです。 |
setColorMap(colorMap)
画像を画像化する際に使用するカラーマップを指定します。
Parameters:
| Name | Type | Description |
|---|---|---|
colorMap |
ColorMapObject | カラーマップを表すColorMapObjectです。 |
setSize(width, height)
取得する画像のサイズを指定します。
Parameters:
| Name | Type | Description |
|---|---|---|
width |
number | 幅のピクセル数です。 |
height |
number | 高さのピクセル数です。 |
Type Definitions
Image-onloading(src, progress)
Image#initにおいて、データを取得している最中に実行されるコールバック関数です。COG (Cloud Optimized GeoTIFF)におけるタイルの単位でデータが読み込まれるたびに実行されます。
Parameters:
| Name | Type | Description |
|---|---|---|
src |
src | 読み込みが完了しているタイルのみを可視化した画像のDataURLです。 |
progress |
number | 0~100%の数値で表した進捗率です。 |