Module: ol

OpenLayersと連携するための機能をまとめたモジュールです。

Methods

(async, static) createLayer(params) → {ol.layer.Image}

OpenLayersで読み込めるレイヤーインスタンスを取得します。
Parameters:
Name Type Description
params Object {ol.layer.Image} のインスタンスを取得するための条件です。
Properties
Name Type Attributes Default Description
ol Object OpenLayersのモジュールへの参照です。OpenLayersはv7.3.0以上を指定してください。OpenLayersをモジュールでインポートして利用する場合は、下記のExampleに示すようなolオブジェクトを作成してparams.olに設定してください。
collection string データセットのcollection.jsonのURLです。
band string <optional>
 collection.jsonの中で定義されているデータセットが持つバンド名です。省略した場合はデータセット内で一つ目に定義されているバンドを自動で設定します。
colorMap ColorMapObject <optional>
 可視化に使用するカラーマップです。省略した場合は、全球レベルにおける最小値～最大値までを黒～白で可視化するように自動で設定します。
date Date <optional>
 new Date() この日時のImageインスタンスが取得されます。
tid number <optional>
 この時刻IDに対応したImageインスタンスが取得されます。dateまたはtidを指定してください。
onloadstart module:ol.createLayer-onloadstart <optional>
 function(){} 地図のスクロールズームが完了し、データ取得を開始した際に実行されるコールバック関数です。
onloading module:ol.createLayer-onloading <optional>
 function(){} タイル単位でデータが取得される度に実行されるコールバック関数です。
onloadend module:ol.createLayer-onloadend <optional>
 function(){} データ取得を終了した際に実行されるコールバック関数です。
opacity number <optional>
 1 レイヤーの不透明度です。0(透明)～1(不透明)の値を指定してください。
projection string <optional>
 "EPSG:4326" 地図の投影法です。現状はEPSG:4326(等緯度経度)のデータセットをEPSG:3857(ウェブメルカトル)で表示させる場合にのみ対応しており、その場合は"EPSG:3857"を指定します。
bilinearResampling boolean <optional>
 false trueの場合は高精度なバイリニアリサンプリングを使用します。取得した地形データから傾斜を求めるような微分の計算を行なう場合には必要です。falseの場合には高速なニアレストネイバーを使用します。
See:
Returns:
{ol.layer.Image}のインスタンスを返します。このインスタンスに対しては、getImageCollectionによりImageCollection、getImageによりImageを取得できます。また、setDateにより日時を切り替え、setColorMapにより色を変更、getLegendにより凡例を取得することも可能です。
Type
ol.layer.Image
Example
//OpenLayersをモジュールでインポートして利用する場合は、次のようなolオブジェクトを作成してparams.olに設定してください。
import ImageCanvas from 'ol/source/ImageCanvas';
import Image from 'ol/layer/Image';

const ol = {
	"source": {
		ImageCanvas
	},
	"layer": {
		Image
	},
};
console.log(ol);

Type Definitions

createLayer-onloadend(image, progress)

module:ol.createLayerにおいて、データ取得を完了した時に実行されるコールバック関数です。
Parameters:
Name Type Description
image Image 読み込みが完了したImageインスタンスです。
progress number 0~100%の数値で表した進捗率です。

createLayer-onloading(progress)

module:ol.createLayerにおいて、データを取得している最中に実行されるコールバック関数です。COG (Cloud Optimized GeoTIFF)におけるタイルの単位でデータが読み込まれるたびに実行されます。
Parameters:
Name Type Description
progress number 0~100%の数値で表した進捗率です。

createLayer-onloadstart()

module:ol.createLayerにおいて、地図のスクロールズームが完了し、データ取得を開始したタイミングで実行されるコールバック関数です。