ee.Dictionary.getString

  • Dictionary.getString() extracts a named string value associated with a given key from an Earth Engine dictionary.

  • The function takes the dictionary and the key string as input and returns the corresponding string value.

  • It is helpful for accessing specific string properties within dictionaries, such as those generated from ee.Image.reduceRegion.

  • Usage is demonstrated through JavaScript and Python examples within the documentation.

 Extracts a named string value from a dictionary.

UsageReturns
Dictionary.getString(key)String
ArgumentTypeDetails
this: dictionaryDictionary
keyString

Examples

Code Editor (JavaScript)

// A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
var dict = ee.Dictionary({
  B1: 182,
  B2: 219,
  B3: 443,
  Region: 'The Forest of Nisene Marks State Park'
});

print('The "Region" value as an ee.String object', dict.getString('Region'));

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)

# A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
dic = ee.Dictionary({
    'B1': 182,
    'B2': 219,
    'B3': 443,
    'Region': 'The Forest of Nisene Marks State Park'
})

print('The "Region" value as an ee.String object:',
      dic.getString('Region').getInfo(), sep='\n')