Stay organized with collectionsSave and categorize content based on your preferences.
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-19 UTC."],[[["\u003cp\u003e\u003ccode\u003eNumber.format()\u003c/code\u003e converts Earth Engine Numbers to strings using printf-style formatting.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epattern\u003c/code\u003e argument accepts a format string, like '%.2f' for 2 decimal places or '%03d' for zero-padding to 3 digits.\u003c/p\u003e\n"],["\u003cp\u003eThis function allows customization of numeric output for display or further processing within Earth Engine scripts.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the Java Formatter documentation for details on available format string options and syntax.\u003c/p\u003e\n"]]],[],null,["# ee.Number.format\n\nConvert a number to a string using printf-style formatting.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------|---------|\n| Number.format`(`*pattern*`)` | String |\n\n| Argument | Type | Details |\n|----------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `number` | Number | The number to convert to a string. |\n| `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: 1. Zero or more prefix characters. 2. Exactly one '%'. 3. Zero or more modifier characters in the set \\[#-+ 0,(.\\\\d\\]. 4. Exactly one conversion character in the set \\[sdoxXeEfgGaA\\]. 5. 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 |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint('Zero-fill to length of 3',\n ee.Number(1).format('%03d')); // 001\n\nprint('Include 1 decimal place in 1.2347',\n ee.Number(1.23476).format('%.1f')); // 1.2\n\nprint('Include 3 decimal places in 1.2347',\n ee.Number(1.23476).format('%.3f')); // 1.235 (rounds up)\n\nprint('Scientific notation with 3 decimal places shown',\n ee.Number(123476).format('%.3e')); // 1.235e+05 (rounds up)\n\nprint('Integer with 2 decimal places of precision',\n ee.Number(123476).format('%.2f')); // 123476.00\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\nprint('Zero-fill to length of 3:',\n ee.Number(1).format('%03d').getInfo()) # 001\n\nprint('Include 1 decimal place in 1.2347:',\n ee.Number(1.23476).format('%.1f').getInfo()) # 1.2\n\nprint('Include 3 decimal places in 1.2347:',\n ee.Number(1.23476).format('%.3f').getInfo()) # 1.235 (rounds up)\n\nprint('Scientific notation with 3 decimal places shown:',\n ee.Number(123476).format('%.3e').getInfo()) # 1.235e+05 (rounds up)\n\nprint('Integer with 2 decimal places of precision:',\n ee.Number(123476).format('%.2f').getInfo()) # 123476.00\n```"]]
