---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Cor - com escopo, global

# Cor - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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 documento](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") para gerar um PDF.

## Cor - Cor (cores da matriz) {#ariaid-title2}

Instancia um novo objeto de cor com valores RGB.
A cor pode ser aplicada aos seguintes cenários:
{#Color-Color_A__table_twm_hjk_34b__entry__3}

| 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 1. Parâmetros]

{#Color-Color_A__table_twm_hjk_34b}  
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) {#ariaid-title3}

Indica se os valores de dois objetos de cores diferentes correspondem.
{#Color-equals_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cor | Cor | Objeto de cor para verificar se há correspondência. |
[Tabela 2. Parâmetros]

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

| 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. {#Color-equals_O__ul_grr_53x_r4b} |
[Tabela 3. Retorna]

{#Color-equals_O__table_wv5_52h_44b}  
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) {#ariaid-title4}

Retorna um objeto de cor preta, cinza ou branca.
{#Color-getGrayColor_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| escalacinza | Número | Valor decimal no intervalo de 0 a 1, em que 0 é preto e 1 é branco. |
[Tabela 4. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Objeto de cor que reflete o valor da escala de cinza fornecido. |
[Tabela 5. Retorna]

{#Color-getGrayColor_N__table_wv5_52h_44b}  
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) {#ariaid-title5}

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.
{#Color-setColorValue_A__table_vv5_52h_44b__entry__3}

| 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 6. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 7. Retorna]

{#Color-setColorValue_A__table_wv5_52h_44b}  
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) {#ariaid-title6}

Define o nível de opacidade da cor.
{#Color-setOpacity_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cor | Cor | Valor decimal flutuante de 0 a 1, no qual 0 é totalmente transparente e 1 é totalmente opaco. |
[Tabela 8. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Retorna]

{#Color-setOpacity_N__table_wv5_52h_44b}  
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);