Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.String.encodeJSON
Stay organized with collections
Save and categorize content based on your preferences.
Encodes an object to JSON. Supports primitives, lists, and dictionaries.
| Usage | Returns | ee.String.encodeJSON(object) | String |
| Argument | Type | Details | object | Object | The object to encode. |
Examples
Code Editor (JavaScript)
print('JSON-encoded ee.String',
ee.String.encodeJSON(ee.String('earth'))); // "\"earth\""
print('JSON-encoded ee.Number',
ee.String.encodeJSON(ee.Number(1))); // "1"
print('JSON-encoded ee.List',
ee.String.encodeJSON(ee.List([1, 2, 3]))); // "[1,2,3]"
print('JSON-encoded ee.Dictionary',
ee.String.encodeJSON(ee.Dictionary({lc_name: 'grassland', lc_class: 3})));
// "{\"lc_class\":3,\"lc_name\":\"grassland\"}"
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)
print('JSON-encoded ee.String:',
repr(ee.String.encodeJSON(ee.String('earth')).getInfo())) # '\"earth\"'
print('JSON-encoded ee.Number:',
repr(ee.String.encodeJSON(ee.Number(1)).getInfo())) # '1'
print('JSON-encoded ee.List:',
repr(ee.String.encodeJSON(ee.List([1, 2, 3])).getInfo())) # '[1,2,3]'
print('JSON-encoded ee.Dictionary:',
repr(ee.String.encodeJSON(
ee.Dictionary({'lc_name': 'grassland', 'lc_class': 3})).getInfo()))
# '{\"lc_class\":3,\"lc_name\":\"grassland\"}'
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-13 UTC.
[null,null,["Last updated 2024-07-13 UTC."],[[["\u003cp\u003e\u003ccode\u003eee.String.encodeJSON\u003c/code\u003e converts Earth Engine objects like strings, numbers, lists, and dictionaries into JSON format.\u003c/p\u003e\n"],["\u003cp\u003eThis function returns the JSON representation of the input object as an \u003ccode\u003eee.String\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUsage examples demonstrate encoding various Earth Engine data types into their respective JSON equivalents.\u003c/p\u003e\n"],["\u003cp\u003eThe encoded JSON string can then be used for data exchange or further processing.\u003c/p\u003e\n"]]],["The `ee.String.encodeJSON(object)` method encodes an object into a JSON string. It accepts various object types, including primitives, lists, and dictionaries, as input. The method returns a JSON string representation of the input object. Examples demonstrate encoding `ee.String`, `ee.Number`, `ee.List`, and `ee.Dictionary` types in both JavaScript and Python, showing how they are converted into their respective JSON string formats.\n"],null,["# ee.String.encodeJSON\n\nEncodes an object to JSON. Supports primitives, lists, and dictionaries.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------------|---------|\n| `ee.String.encodeJSON(object)` | String |\n\n| Argument | Type | Details |\n|----------|--------|-----------------------|\n| `object` | Object | The object to encode. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint('JSON-encoded ee.String',\n ee.String.encodeJSON(ee.String('earth'))); // \"\\\"earth\\\"\"\n\nprint('JSON-encoded ee.Number',\n ee.String.encodeJSON(ee.Number(1))); // \"1\"\n\nprint('JSON-encoded ee.List',\n ee.String.encodeJSON(ee.List([1, 2, 3]))); // \"[1,2,3]\"\n\nprint('JSON-encoded ee.Dictionary',\n ee.String.encodeJSON(ee.Dictionary({lc_name: 'grassland', lc_class: 3})));\n// \"{\\\"lc_class\\\":3,\\\"lc_name\\\":\\\"grassland\\\"}\"\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('JSON-encoded ee.String:',\n repr(ee.String.encodeJSON(ee.String('earth')).getInfo())) # '\\\"earth\\\"'\n\nprint('JSON-encoded ee.Number:',\n repr(ee.String.encodeJSON(ee.Number(1)).getInfo())) # '1'\n\nprint('JSON-encoded ee.List:',\n repr(ee.String.encodeJSON(ee.List([1, 2, 3])).getInfo())) # '[1,2,3]'\n\nprint('JSON-encoded ee.Dictionary:',\n repr(ee.String.encodeJSON(\n ee.Dictionary({'lc_name': 'grassland', 'lc_class': 3})).getInfo()))\n# '{\\\"lc_class\\\":3,\\\"lc_name\\\":\\\"grassland\\\"}'\n```"]]