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


---

# GlideCurrencyFormatter - com escopo

# GlideCurrencyFormatter - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

A API GlideCurrencyFormatter fornece métodos para formatar cadeias de caracteres de moeda de FX.

Ao instanciar o objeto GlideCurrencyFormatter, você define o formato dos resultados de saída para este objeto. Depois de definido, o mesmo formato é usado sempre que você chama o método GlideCurrencyFormatter.format() desse objeto. Os métodos GlideCurrencyFormatter() e format() são os únicos dois métodos que você deve chamar para formatar moeda de FX.  
A API GlideCurrencyFormatter() também fornece métodos opcionais que permitem:

* Defina a localidade da moeda usando setLocale(). Ao definir a localidade, o formatador leva em consideração qualquer formatação específica para essa localidade, por exemplo, se uma vírgula decimal ou vírgula decimal é usada para denotar frações do valor da moeda. Padrão: localidade do sistema
* Defina o número mínimo de dígitos fracionários a serem exibidos usando setMinFractionDigits(). Define o número mínimo de dígitos à direita da vírgula decimal/vírgula decimal a serem incluídos. Por padrão, todos os dígitos passados são exibidos. Se o valor aprovado tiver menos dígitos do que o mínimo especificado, o resultado será preenchido com "0".
* Defina o número máximo de dígitos fracionários a serem exibidos usando setMaxFractionDigits(). Define o número máximo de dígitos à direita da vírgula decimal/vírgula decimal a serem incluídos. Por padrão, todos os dígitos passados são exibidos. Se o valor aprovado tiver um número de dígitos maior do que o máximo especificado, os dígitos adicionais serão truncados durante o processo de arredondamento para o número máximo de dígitos de frações. O arredondamento é realizado para o dígito mais à direita. Por exemplo, se o dígito de fração máxima estiver definido como 2 e o valor da moeda passado for 123,456, o valor formatado será 123,46. Se o valor da moeda for 23.122, o valor formatado será 23.12. Se o máximo estiver definido como menor que o mínimo, o valor mínimo será usado.
{#GlideCurrencyFormatterScopedAPI__ul_gtn_n5d_4jb}

Esta classe é executada no namespace `sn_currency`.

## GlideCurrencyFormatter - GlideCurrencyFormatter(cadeia de caracteres formatString) {#ariaid-title2}

Instancia um objeto GlideCurrencyFormatter e define a cadeia de caracteres de formato a ser usada para formatar a moeda FX.
Este método não executa o formato de cadeia de caracteres real. Você deve chamar o método GlideCurrencyFormatter.format() para formatar a moeda.
{#Scoped-GCF-GlideCurrForm_S__table_g3b_vbc_fy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| formatString | Cadeia de caracteres | Opcional. Cadeia de caracteres de formato a ser usada para formatar qualquer moeda passada para o formatador. Valores válidos: * %s: substituído pelo símbolo da moeda associado ao código do país especificado na chamada format(). * %v: substituído pelo valor da moeda, como 123,45. * %c: substituído pelo código de moeda ISO especificado na chamada format(), como USD ou EUR. * %l: substituído pelo valor passado, nenhuma formatação realizada. * %p: substituído pelo sinal de porcentagem (%). {#Scoped-GCF-GlideCurrForm_S__ul_sv5_qzc_4jb} Por exemplo, se a cadeia de caracteres de formato for '%s%v%c' e o valor a ser formatado for 123,45 em dólares norte-americanos, a cadeia de caracteres formatada retornada será $123,45 USD. Se a cadeia de caracteres de formato for '%s%l%c' e a cadeia de caracteres de valor a ser formatada for '56M' em Euros, a cadeia de caracteres formatada retornada será de 56M EUR. Nota: A mesma cadeia de caracteres de formato é usada sempre que o método format() é chamado neste objeto. |
[Tabela 1. Parâmetros]

{#Scoped-GCF-GlideCurrForm_S__table_g3b_vbc_fy}  
Este exemplo mostra como chamar o método.

    var formatString = '%s%v%c';
    var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);

## GlideCurrencyFormatter - format(cadeia de caracteres valor, cadeia de caracteres currencyCode) {#ariaid-title3}

Formata um valor de moeda especificado usando o código de moeda especificado.
O formato resultante da moeda também depende dos valores passados quando o objeto GlideCurrencyFormatter foi instanciado inicialmente.
{#Scoped-GCF-format_S_S__table_hxs_f4c_fy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| valor | Cadeia de caracteres | Valor da moeda a ser formatado. O valor só pode conter uma vírgula decimal para denotar o valor fracionário, não há suporte para vírgulas. Valores válidos: 123,45 ou 2436,23 Valores inválidos 123,45 ou 2.134,56 |
| currencyCode | Cadeia de caracteres | Código de moeda ISO de três letras a ser usado ao formatar a moeda. |
[Tabela 2. Parâmetros]

{#Scoped-GCF-format_S_S__table_hxs_f4c_fy} {#Scoped-GCF-format_S_S__table_ixs_f4c_fy__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor da moeda formatado. |
[Tabela 3. Retorna]

{#Scoped-GCF-format_S_S__table_ixs_f4c_fy}  
Este exemplo mostra como chamar o método.

    var amount = '123456.123456789';
    var currencyCode = 'USD';
    var formatString = '%s%v%c';
    var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
    gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Saída:

    Formatted currency: $123,456.12USD

## GlideCurrencyFormatter - setLocale(cadeia de caracteres idioma, cadeia de caracteres país) {#ariaid-title4}

Define o idioma e o país padrão, que constituem a localidade, para o formatador de moeda.
Se você não chamar este método antes de chamar o método GlideCurrencyFormatter.format(), a localidade será padronizada para a localidade da sessão atual.
{#Scoped-GCF-setLocale_S_S__table_ens_mkc_fy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| idioma | Cadeia de caracteres | Código de idioma ISO 639 de duas letras, como en, sp e fr. |
| país | Cadeia de caracteres | Código de país ISO 3166 de duas letras, como US, ES e FR. |
[Tabela 4. Parâmetros]

{#Scoped-GCF-setLocale_S_S__table_ens_mkc_fy} {#Scoped-GCF-setLocale_S_S__table_fns_mkc_fy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 5. Retorna]

{#Scoped-GCF-setLocale_S_S__table_fns_mkc_fy}  
Este exemplo mostra a configuração do formatador de moeda para a França.

    var amount = '123456.123456789';
    var currencyCode = 'EUR';
    var formatString = '%s%v%c';
    var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
    exchangeValue.setLocale("fr", "FR"); // Language = fr Country = FR
    gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Saída:

    Formatted currency: €123 456,12EUR

## GlideCurrencyFormatter - setMaxFractionDigits(Number maxFractionDigits) {#ariaid-title5}

Define o número máximo de dígitos à direita da vírgula decimal/vírgula decimal a serem retornados.
{#Scoped-GCF-setMaxFractDig_N__table_ltc_1kc_fy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| maxFractionDigits | Número | Número máximo de dígitos de frações a serem retornados. Se este valor estiver definido como algo menor que o valor minFractionDigits, ele será substituído por minFractionDigits. |
[Tabela 6. Parâmetros]

{#Scoped-GCF-setMaxFractDig_N__table_ltc_1kc_fy} {#Scoped-GCF-setMaxFractDig_N__table_mtc_1kc_fy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 7. Retorna]

{#Scoped-GCF-setMaxFractDig_N__table_mtc_1kc_fy}  
Este exemplo mostra como chamar o método.

    var amount = '123456.123456789';
    var currencyCode = 'USD';
    var formatString = '%s%v%c';
    var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
    gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Saída:

    Formatted currency: $123,456.12USD

## GlideCurrencyFormatter -- setMinFractionDigits(Number minFractionDigits) {#ariaid-title6}

Define o número mínimo de dígitos de frações (à direita da vírgula decimal/vírgula decimal) a serem retornados.
{#Scoped-GCF-setMinFranctDig_N__table_hbs_b2c_fy__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| minFractionDigits | Número | Número mínimo de dígitos de frações a serem retornados. |
[Tabela 8. Parâmetros]

{#Scoped-GCF-setMinFranctDig_N__table_hbs_b2c_fy} {#Scoped-GCF-setMinFranctDig_N__table_ibs_b2c_fy__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 9. Retorna]

{#Scoped-GCF-setMinFranctDig_N__table_ibs_b2c_fy}  

    var amount = '123456.12';
    var currencyCode = 'USD';
    var formatString = '%s%v%c';
    var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
    gs.info('Formatted currency: ' + exchangeValue.setMinFractionDigits(3).format(amount, currencyCode));

Saída:

    Formatted currency: $123,456.120USD