Color - Scoped, Global

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 5분

    • Creates a Color object used to define color attributes that you can apply to elements in a PDF; such as cells, tables, and lines.

    This API is part of the ServiceNow PDF Generation Utilities plugin (com.snc.apppdfgenerator) and is provided within the sn_pdfgeneratorutils namespace. The plugin is activated by default.

    This API is a component used with the Document API to generate a PDF.

    Color - Color(Array colors)

    Instantiates a new Color object with RGB values.

    Color can be applied to the following scenarios:

    표 1. Parameters
    Name Type Description
    colors Array Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in [0.1, 0.9, 0.5], the value of the first position is red, second is green, and third is blue. Also, [0, 0, 0] is solid black, [0.5, 0.5, 0.5] is solid gray, and [1, 1, 1] is solid white.

    The following example shows how to create a Color object.

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

    Color – equals(Color color)

    Indicates whether the values of two different color objects match.

    표 2. Parameters
    Name Type Description
    color Color Color object to check for a match.
    표 3. Returns
    Type Description
    Boolean

    Flag that indicates whether the values of two color objects match.

    Valid values:
    • true: The colors match.
    • false: The colors do not match.

    The following example shows how to create two color objects and determine if the colors match.

    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(Number grayScale)

    Returns a black, gray, or white color object.

    표 4. Parameters
    Name Type Description
    grayScale Number Decimal value in the range 0 through 1, in which 0 is black and 1 is white.
    표 5. Returns
    Type Description
    Object Color object reflecting the provided grayscale value.

    The following example shows how to create a color object that is 50% grayscale.

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

    Color – setColorValue(Array colors)

    Creates color with given values and enables you to change the values of an existing color. Each of the values must be from 0 through 1.

    표 6. Parameters
    Name Type Description
    colors Array Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in [0.1, 0.9, 0.5], the value of the first position is red, second is green, and third is blue. Also, [0, 0, 0] is solid black, [0.5, 0.5, 0.5] is solid gray, and [1, 1, 1] is solid white.
    표 7. Returns
    Type Description
    None

    The following example shows how to change the values of an existing color.

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

    Color – setOpacity(Number opacity)

    Sets the level of color opacity.

    표 8. Parameters
    Name Type Description
    color Color Floating decimal value from 0 through 1, in which 0 is fully transparent and 1 is fully opaque.
    표 9. Returns
    Type Description
    None

    The following example shows how to create a color object and set its opacity to 50 percent.

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