色 - スコープ対象、グローバル

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

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

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

色:色 (アレイ色)

RGB 値を持つ新しい 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(色の色)

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

表 : 2. パラメーター

名前	タイプ	説明
色	色	一致をチェックする色オブジェクト。

表 : 3. 戻り値

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

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

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);

色 – getGrayColor(Number grayScale)

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

表 : 4. パラメーター

名前	タイプ	説明
グレースケール	番号	0 〜 1 の範囲の 10 進数値。0 は黒、1 は白です。

表 : 5. 戻り値

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

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

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

色:setColorValue(アレイの色)

指定された値で色を作成し、既存の色の値を変更できるようにします。各値は 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(数値の不透明度)

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

表 : 8. パラメーター

名前	タイプ	説明
色	色	0 から 1 までの浮動小数点以下桁数の値。0 は完全に透明、1 は完全に不透明です。

表 : 9. 戻り値

タイプ	説明
なし

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

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