Función Formatear número

La función Formatear número devuelve una serie que es un número formateado para que se ajuste el patrón especificado.

Parámetro: number

El número que debe formatearse. Puede hacerse desde un nodo de origen, el resultado de otra función o un valor especificado por el usuario.

Parámetro: string

Un patrón que especifica cómo debería formatearse el primer parámetro. Este patrón utiliza estos símbolos para definir el patrón:
  • Dígitos necesarios = 0
  • Dígitos opcionales = #
  • Símbolo menos = -
  • Punto = .
  • Separador de agrupación = ,.Normalmente se utiliza para separar grupos de tres dígitos.
  • Símbolo de porcentaje = %. Cuando existe el símbolo de porcentaje, el número de entrada se multiplica por 100 y el resultado se muestra en forma de porcentaje.
  • Símbolo de milésima =  (Unicode x2030). Este símbolo multiplica el número por 1000 y muestra el resultado en forma de milésima.
  • Separador positivo/negativo = ;
  • Infinidad = infinidad
  • No es un número = NaN
  • $ = $
Patrones que pueden tener texto constante como prefijo, sufijo o ambos. Sus usos más habituales son para especificar el símbolo de moneda o alguna unidad de medida.
  • $#,##0.00 – formatea un número en el formato estándar de los dólares de los Estados Unidos con el símbolo del dólar, comas para separadores y, como mínimo, un dígito para los dólares y dos dígitos para los centavos.
  • #0.000% – formatea un número decimal como porcentaje con, como mínimo, tres posiciones decimales.
  • #,##0.00;(#,##0.00) – formatea números negativos con paréntesis; se trata de un formato que se utiliza habitualmente para contabilidad.

Devuelve: serie

El primer parámetro reformateado para que refleje el patrón especificado por el segundo parámetro.

Ejemplos

Patrones que pueden tener texto constante como prefijo, sufijo o ambos. Sus usos más habituales son para especificar el símbolo de moneda o alguna unidad de medida.

Ejemplo 1

$#,##0.00 – formatea un número en el formato estándar de los dólares de los Estados Unidos con el símbolo del dólar, comas para separadores y, como mínimo, un dígito para los dólares y dos dígitos para los centavos.

format-number(12345.6789,'$#,##0.00') = '$12,345.67'
Ejemplo 2

#0.000% – formatea un número decimal como porcentaje con, como mínimo, tres posiciones decimales.

format-number(.67890123,'#0.000%') = '67.890%'

Cuando existe el símbolo de porcentaje, el número de entrada se multiplica por 100.

Ejemplo 3

#,##0.00;(#,##0.00) – formatea números negativos con paréntesis; se trata de un formato que se utiliza habitualmente para contabilidad.

format-number(-12345.6789,'#,##0.00;(#,##0.00)') = '(12,345.67)'