ee.Number.format

AI-generated Key Takeaways

• The Number.format() method converts a number to a string using printf-style formatting.

• The pattern argument is a printf-style format string that specifies how the number should be formatted.

• Examples demonstrate formatting numbers with zero-filling, specific decimal places, and scientific notation.

Convert a number to a string using printf-style formatting.

Usage	Returns
Number.format(pattern)	String

Argument	Type	Details
this: number	Number	The number to convert to a string.
pattern	String, default: "%s"	A printf-style format string. For example, '%.2f' produces numbers formatted like '3.14', and '%05d' produces numbers formatted like '00042'. The format string must satisfy the following criteria: Zero or more prefix characters. Exactly one '%'. Zero or more modifier characters in the set [#-+ 0,(.\d]. Exactly one conversion character in the set [sdoxXeEfgGaA]. Zero or more suffix characters. For more about format strings, see https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Formatter.html

Examples

Code Editor (JavaScript)

print('Zero-fill to length of 3',
      ee.Number(1).format('%03d'));  // 001

print('Include 1 decimal place in 1.2347',
      ee.Number(1.23476).format('%.1f'));  // 1.2

print('Include 3 decimal places in 1.2347',
      ee.Number(1.23476).format('%.3f'));  // 1.235 (rounds up)

print('Scientific notation with 3 decimal places shown',
      ee.Number(123476).format('%.3e'));  // 1.235e+05 (rounds up)

print('Integer with 2 decimal places of precision',
      ee.Number(123476).format('%.2f'));  // 123476.00

Python setup

See the Python Environment page for information on the Python API and using geemap for interactive development.

import ee
import geemap.core as geemap

Colab (Python)

display('Zero-fill to length of 3:',
        ee.Number(1).format('%03d'))  # 001

display('Include 1 decimal place in 1.2347:',
        ee.Number(1.23476).format('%.1f'))  # 1.2

display('Include 3 decimal places in 1.2347:',
        ee.Number(1.23476).format('%.3f'))  # 1.235 (rounds up)

display('Scientific notation with 3 decimal places shown:',
        ee.Number(123476).format('%.3e'))  # 1.235e+05 (rounds up)

display('Integer with 2 decimal places of precision:',
        ee.Number(123476).format('%.2f'))  # 123476.00