Color -スコープ付き、グローバル

PDF の要素に適用できるセル、テーブル、行などの色属性を定義するために使用する Color オブジェクトを作成します。

この API は、 ServiceNow PDF 生成ユーティリティプラグイン (com.snc.apppdfgenerator) の一部であり、 sn_pdfgeneratorutils 名前空間内で提供されます。このプラグインはデフォルトでは有効になっています。

この API は、PDF を生成するためにドキュメント API とともに使用されるコンポーネントです。

Color - Color(アレイ colors)

RGB 値を使用して新しい Color オブジェクトをインスタンス化します。

Color は次のシナリオに適用できます。

表 : 1. パラメーター

名前	タイプ	説明
colors	アレイ	0 〜 1 の 10 進数値を使用して RGB 値を示す 3 つの数字。たとえば、[0.1, 0.9, 0.5] では、最初の位置の値は赤、2 番目は緑、3 番目は青です。また、[0, 0, 0] は黒一色、 [0.5, 0.5, 0.5] はグレー一色、 [1, 1, 1] は白一色です。

次の例は、Color オブジェクトを作成する方法を示しています。

var color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values

Color – equals(色 color)

2 つの異なる Color オブジェクトの値が一致するかどうかを示します。

表 : 2. パラメーター

名前	タイプ	説明
color	色	一致するか確認する Color オブジェクトです。

表 : 3. 返される内容

タイプ	説明
ブーリアン	2 つの異なる Color オブジェクトの値が一致するかどうかを示すフラグです。 有効な値： true：色は一致します。 false：色は一致しません。

次の例は、2 つの Color オブジェクトを作成し、色が一致するかどうかを判断する方法を示しています。

var color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);  // given as an array of RGB values
var color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]);         // given as an array of RGB values
var isequal = color1.equals(color2);

Color – getGrayColor(数値 grayScale)

黒、グレー、または白の Color オブジェクトを返します。

表 : 4. パラメーター

名前	タイプ	説明
grayScale	番号	0 〜 1 の範囲の 10 進数値。0 は黒、1 は白です。

表 : 5. 返される内容

タイプ	説明
オブジェクト	指定されたグレースケール値を反映する Color オブジェクトです。

次の例は、50% のグレースケールの Color オブジェクトを作成する方法を示しています。

var grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);

Color – setColorValue(アレイ colors)

指定された値を使用して色を作成し、既存の色の値を変更できるようにします。各値は 0 〜 1 の範囲でなければなりません。

表 : 6. パラメーター

名前	タイプ	説明
colors	アレイ	0 〜 1 の 10 進数値を使用して RGB 値を示す 3 つの数字。たとえば、[0.1, 0.9, 0.5] では、最初の位置の値は赤、2 番目は緑、3 番目は青です。また、[0, 0, 0] は黒一色、 [0.5, 0.5, 0.5] はグレー一色、 [1, 1, 1] は白一色です。

表 : 7. 返される内容

タイプ	説明
なし

次の例は、既存の色の値を変更する方法を示しています。

var color = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);   //given as array of RGB values;
color.setColorValue(color);

Color – setOpacity(数値 opacity)

色の不透明度のレベルを設定します。

表 : 8. パラメーター

名前	タイプ	説明
color	色	0 〜 1 の浮動小数点値。0 は完全に透明で、1 は完全に不透明です。

表 : 9. 返される内容

タイプ	説明
なし

次の例は、Color オブジェクトを作成して不透明度を 50 パーセントに設定する方法を示しています。

var color = new Color([1,0.5,0.5]);
color.setOpacity(0.5);