new ColorMap(params)
module:image.createImageで使用するカラーマップを作成します。
現状このクラスはmodule:image.createImage以外では使用されていません。getImageやImage#setColorMap等では全てColorMapObjectを直接指定する方法に置き換えられており、今後大幅な仕様変更または廃止される可能性があります。
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
params |
Object | インスタンスを作成するための条件です。
Properties
|
- See:
Methods
get(x) → {Uint8ClampedArray}
指定した値に塗る色の色コードをUint8ClampedArrayとして取得します。
Parameters:
Name | Type | Description |
---|---|---|
x |
number | 色を求める値です。 |
Returns:
色コードRRGGBBAAをnew Uint8ClampedArray([r,g,b,a])にしたものです。
- Type
- Uint8ClampedArray
getColorBar(width, height) → {HTMLCanvasElement}
カラーマップの名称または色コードの配列に従ってグラデーションの画像を描画したHTMLCanvasElementを作成します。
目盛の数字や単位を書き込む場合はgetLegendを使用してください。
Parameters:
Name | Type | Description |
---|---|---|
width |
number | 幅のピクセル数です。 |
height |
number | 高さのピクセル数です。 |
Returns:
グラデーションの画像を描画したHTMLCanvasElementです。
- Type
- HTMLCanvasElement
getColors() → {string|Array.<string>}
カラーマップの名称または色コードの配列を取得します。
Returns:
カラーマップの名称または色コードの配列です。
- Type
- string | Array.<string>
getDeleteMax() → {boolean}
最大値以下を透明にするかどうかの設定を取得します。
Returns:
最大値以下を透明にするかどうかの設定です。
- Type
- boolean
getDeleteMin() → {boolean}
最小値以下を透明にするかどうかの設定を取得します。
Returns:
最小値以下を透明にするかどうかの設定です。
- Type
- boolean
getLegend(width, height, fontSize, unitopt) → {HTMLCanvasElement}
凡例の画像を描画したHTMLCanvasElementを作成します。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
width |
number | 凡例画像の幅(ピクセル数)です。 | |
height |
number | 凡例画像の高さ(ピクセル数)です。 | |
fontSize |
number | 凡例画像内の文字サイズ(ピクセル数)です。 | |
unit |
string |
<optional> |
凡例画像内に表示する単位の文字列です。 |
Returns:
凡例の画像を描画したHTMLCanvasElementです。
- Type
- HTMLCanvasElement
getMax() → {number}
色を塗る範囲の最大値を取得します。
Returns:
色を塗る範囲の最大値です。
- Type
- number
getMin() → {number}
色を塗る範囲の最小値を取得します。
Returns:
色を塗る範囲の最小値です。
- Type
- number
getNaNColor() → {Uint8ClampedArray}
NaNに塗る色の色コードをUint8ClampedArrayとして取得します。
Returns:
NaNに塗る色の色コードRRGGBBAAをnew Uint8ClampedArray([r,g,b,a])にしたものです。
- Type
- Uint8ClampedArray
getParams() → {ColorMapObject}
設定内容をColorMapObjectとして全て取得します。ただし、nanColorはUint8ClampedArrayに置き換えられています。
Returns:
設定内容のColorMapObjectです。
- Type
- ColorMapObject