Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Dictionary.getString
Stay organized with collections
Save and categorize content based on your preferences.
Extracts a named string value from a dictionary.
| Usage | Returns | Dictionary.getString(key) | String |
| Argument | Type | Details | this: dictionary | Dictionary | |
key | String | |
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')
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 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eDictionary.getString()\u003c/code\u003e extracts a named string value associated with a given key from an Earth Engine dictionary.\u003c/p\u003e\n"],["\u003cp\u003eThe function takes the dictionary and the key string as input and returns the corresponding string value.\u003c/p\u003e\n"],["\u003cp\u003eIt is helpful for accessing specific string properties within dictionaries, such as those generated from \u003ccode\u003eee.Image.reduceRegion\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUsage is demonstrated through JavaScript and Python examples within the documentation.\u003c/p\u003e\n"]]],[],null,["# ee.Dictionary.getString\n\nExtracts a named string value from a dictionary.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------------------|---------|\n| Dictionary.getString`(key)` | String |\n\n| Argument | Type | Details |\n|--------------------|------------|---------|\n| this: `dictionary` | Dictionary | |\n| `key` | String | |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).\nvar dict = ee.Dictionary({\n B1: 182,\n B2: 219,\n B3: 443,\n Region: 'The Forest of Nisene Marks State Park'\n});\n\nprint('The \"Region\" value as an ee.String object', dict.getString('Region'));\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\n# A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).\ndic = ee.Dictionary({\n 'B1': 182,\n 'B2': 219,\n 'B3': 443,\n 'Region': 'The Forest of Nisene Marks State Park'\n})\n\nprint('The \"Region\" value as an ee.String object:',\n dic.getString('Region').getInfo(), sep='\\n')\n```"]]