---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

# Color -スコープ付き、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：3分

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

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

この API は、PDF を生成するために[ドキュメント API](https://servicenow-prod.fluidtopics.net/PkT2cVgUF6xDOPZvUnjHtw#DocumentBothAPI "Document API には、PDF の初期化、コンテンツの追加、PDF のクローズを行うメソッドが用意されています。コンテンツを追加した後、ドキュメントをターゲットレコードに添付できます。") とともに使用されるコンポーネントです。

## Color - Color(アレイ colors) {#ariaid-title2}

RGB 値を使用して新しい Color オブジェクトをインスタンス化します。
Color は次のシナリオに適用できます。
{#Color-Color_A__table_twm_hjk_34b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 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]` は白一色です。 |
[表 : 1. パラメーター]

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

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

## Color -- equals(色 color) {#ariaid-title3}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| color | 色 | 一致するか確認する Color オブジェクトです。 |
[表 : 2. パラメーター]

{#Color-equals_O__table_vv5_52h_44b} {#Color-equals_O__table_wv5_52h_44b__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 2 つの異なる Color オブジェクトの値が一致するかどうかを示すフラグです。 有効な値： * true：色は一致します。 * false：色は一致しません。 {#Color-equals_O__ul_grr_53x_r4b} |
[表 : 3. 返される内容]

{#Color-equals_O__table_wv5_52h_44b}  
次の例は、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) {#ariaid-title4}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| grayScale | 番号 | 0 〜 1 の範囲の 10 進数値。0 は黒、1 は白です。 |
[表 : 4. パラメーター]

{#Color-getGrayColor_N__table_vv5_52h_44b} {#Color-getGrayColor_N__table_wv5_52h_44b__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 指定されたグレースケール値を反映する Color オブジェクトです。 |
[表 : 5. 返される内容]

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

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

## Color -- setColorValue(アレイ colors) {#ariaid-title5}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| 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]` は白一色です。 |
[表 : 6. パラメーター]

{#Color-setColorValue_A__table_vv5_52h_44b} {#Color-setColorValue_A__table_wv5_52h_44b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 7. 返される内容]

{#Color-setColorValue_A__table_wv5_52h_44b}  
次の例は、既存の色の値を変更する方法を示しています。

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

## Color -- setOpacity(数値 opacity) {#ariaid-title6}

色の不透明度のレベルを設定します。
{#Color-setOpacity_N__table_vv5_52h_44b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| color | 色 | 0 〜 1 の浮動小数点値。0 は完全に透明で、1 は完全に不透明です。 |
[表 : 8. パラメーター]

{#Color-setOpacity_N__table_vv5_52h_44b} {#Color-setOpacity_N__table_wv5_52h_44b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 9. 返される内容]

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

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