ee.String.encodeJSON

  • The encodeJSON method of ee.String encodes an Earth Engine object into a JSON string.

  • It supports encoding primitives, lists, and dictionaries.

  • The method returns a String type.

  • The input argument is the object to be encoded.

 Encodes an object to JSON. Supports primitives, lists, and dictionaries.

UsageReturns
ee.String.encodeJSON(object)String
ArgumentTypeDetails
objectObjectThe 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\"}'