Cor - com escopo, global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Cria um objeto Cor usado para definir atributos de cor que você pode aplicar a elementos em um PDF; como células, tabelas e linhas.

    Esta API faz parte do plug-in ServiceNow PDF Generator Utilities (com.snc.apppdfgenerator) e é fornecida no namespace sn_pdfgeneratorutils. O plug-in é ativado por padrão.

    Esta API é um componente usado com a API de documentos para gerar um PDF.

    Cor - Cor (cores da matriz)

    Instancia um novo objeto de cor com valores RGB.

    A cor pode ser aplicada aos seguintes cenários:

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    cores Matriz Três números indicando valores RGB usando um valor decimal de 0 a 1. Por exemplo, em [0.1, 0.9, 0.5], o valor da primeira posição é vermelho, o segundo é verde e o terceiro é azul. Além disso, [0, 0, 0] é preto sólido, [0.5, 0.5, 0.5] é cinza sólido e [1, 1, 1] é branco sólido.

    O exemplo a seguir mostra como criar um objeto Color.

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

    Cor – é igual a (cor da cor)

    Indica se os valores de dois objetos de cores diferentes correspondem.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    cor Cor Objeto de cor para verificar se há correspondência.
    Tabela 3. Retornos
    Tipo Descrição
    Booliano

    Sinalizador que indica se os valores de dois objetos de cor correspondem.

    Valores válidos:
    • verdadeiro: as cores coincidem.
    • falso: as cores não coincidem.

    O exemplo a seguir mostra como criar dois objetos de cor e determinar se as cores correspondem.

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

    Cor – getGrayColor(Número de escalacinza)

    Retorna um objeto de cor preta, cinza ou branca.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    escalacinza Número Valor decimal no intervalo de 0 a 1, em que 0 é preto e 1 é branco.
    Tabela 5. Retornos
    Tipo Descrição
    Objeto Objeto de cor que reflete o valor da escala de cinza fornecido.

    O exemplo a seguir mostra como criar um objeto de cor que é 50% em tons de cinza.

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

    Cor – setColorValue(Matriz de cores)

    Cria uma cor com determinados valores e permite que você altere os valores de uma cor existente. Cada um dos valores deve ser de 0 a 1.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    cores Matriz Três números indicando valores RGB usando um valor decimal de 0 a 1. Por exemplo, em [0.1, 0.9, 0.5], o valor da primeira posição é vermelho, o segundo é verde e o terceiro é azul. Além disso, [0, 0, 0] é preto sólido, [0.5, 0.5, 0.5] é cinza sólido e [1, 1, 1] é branco sólido.
    Tabela 7. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como alterar os valores de uma cor existente.

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

    Cor – setOpacity(Opacidade de número)

    Define o nível de opacidade da cor.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    cor Cor Valor decimal flutuante de 0 a 1, no qual 0 é totalmente transparente e 1 é totalmente opaco.
    Tabela 9. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como criar um objeto de cor e definir sua opacidade para 50%.

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