Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.ImageCollection.getString
Stay organized with collections
Save and categorize content based on your preferences.
Extract a property from a feature.
Usage | Returns | ImageCollection.getString(property) | String |
Argument | Type | Details | this: object | Element | The feature to extract the property from. |
property | String | The property to extract. |
Examples
Code Editor (JavaScript)
// A contrived, empty image collection for simple demonstration.
var col = ee.ImageCollection([]);
print('Collection without properties', col);
// Set collection properties using a dictionary.
col = col.set({
project_name: 'biomass_tracking',
project_id: 3,
plot_ids: ee.Array([7, 11, 20])
});
// Set collection properties using a series of key-value pairs.
col = col.set('project_year', 2018,
'rgb_vis', 'false_color');
print('Collection with properties', col);
// Get a dictionary of collection property keys and values.
print('Property keys and values (ee.Dictionary)', col.toDictionary());
// Get the value of a collection property. To use the result of
// ee.ImageCollection.get in further computation, you need to cast it to the
// appropriate class, for example, ee.Number(result) or ee.String(result).
print('Project ID (ambiguous object)', col.get('project_id'));
// Get the value of a string collection property as an ee.String object.
print('Project name (ee.String)', col.getString('project_name'));
// Get the value of a numeric collection property as an ee.Number object.
print('Project year (ee.Number)', col.getNumber('project_year'));
// Get the value of an ee.Array collection property as an ee.Array object.
print('Plot IDs (ee.Array)', col.getArray('plot_ids'));
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)
from pprint import pprint
# A contrived, empty image collection for simple demonstration.
col = ee.ImageCollection([])
print('Collection without properties:')
pprint(col.getInfo())
# Set collection properties using a dictionary.
col = col.set({
'project_name': 'biomass_tracking',
'project_id': 3,
'plot_ids': ee.Array([7, 11, 20])
})
# Set collection properties using a series of key-value pairs.
col = col.set('project_year', 2018,
'rgb_vis', 'false_color')
print('Collection with properties:')
pprint(col.getInfo())
# Get a dictionary of collection property keys and values.
print('Property keys and values (ee.Dictionary):')
pprint(col.toDictionary().getInfo())
# Get the value of a collection property. To use the result of
# ee.ImageCollection.get in further computation, you need to cast it to the
# appropriate class, for example, ee.Number(result) or ee.String(result).
print('Project ID (ambiguous object):', col.get('project_id').getInfo())
# Get the value of a string collection property as an ee.String object.
print('Project name (ee.String):', col.getString('project_name').getInfo())
# Get the value of a numeric collection property as an ee.Number object.
print('Project year (ee.Number):', col.getNumber('project_year').getInfo())
# Get the value of an ee.Array collection property as an ee.Array object.
print('Plot IDs (ee.Array):', col.getArray('plot_ids').getInfo())
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\u003eThe \u003ccode\u003eImageCollection.getString()\u003c/code\u003e method extracts a specified property value as a string from a given feature (or in this case, an Image Collection).\u003c/p\u003e\n"],["\u003cp\u003eProperties can be set on an Image Collection using the \u003ccode\u003eset()\u003c/code\u003e method, either with a dictionary or key-value pairs.\u003c/p\u003e\n"],["\u003cp\u003eRetrieved property values often need to be explicitly cast to the appropriate data type (e.g., \u003ccode\u003eee.Number\u003c/code\u003e, \u003ccode\u003eee.String\u003c/code\u003e) for further use in computations.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eImageCollection.get()\u003c/code\u003e retrieves a property value as an ambiguous object, while methods like \u003ccode\u003egetString()\u003c/code\u003e, \u003ccode\u003egetNumber()\u003c/code\u003e, and \u003ccode\u003egetArray()\u003c/code\u003e retrieve values as specific Earth Engine data types.\u003c/p\u003e\n"]]],["This content demonstrates extracting properties from an `ImageCollection` in Earth Engine. Users can set properties using dictionaries or key-value pairs. The `get()` method retrieves a property's value, but it needs casting (e.g., `ee.Number`, `ee.String`) for computation. Specialized methods like `getString()`, `getNumber()`, and `getArray()` retrieve values as their respective data types. `toDictionary()` returns a dictionary of all properties.\n"],null,["# ee.ImageCollection.getString\n\nExtract a property from a feature.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------|---------|\n| ImageCollection.getString`(property)` | String |\n\n| Argument | Type | Details |\n|----------------|---------|-------------------------------------------|\n| this: `object` | Element | The feature to extract the property from. |\n| `property` | String | The property to extract. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// A contrived, empty image collection for simple demonstration.\nvar col = ee.ImageCollection([]);\nprint('Collection without properties', col);\n\n// Set collection properties using a dictionary.\ncol = col.set({\n project_name: 'biomass_tracking',\n project_id: 3,\n plot_ids: ee.Array([7, 11, 20])\n});\n\n// Set collection properties using a series of key-value pairs.\ncol = col.set('project_year', 2018,\n 'rgb_vis', 'false_color');\n\nprint('Collection with properties', col);\n\n// Get a dictionary of collection property keys and values.\nprint('Property keys and values (ee.Dictionary)', col.toDictionary());\n\n// Get the value of a collection property. To use the result of\n// ee.ImageCollection.get in further computation, you need to cast it to the\n// appropriate class, for example, ee.Number(result) or ee.String(result).\nprint('Project ID (ambiguous object)', col.get('project_id'));\n\n// Get the value of a string collection property as an ee.String object.\nprint('Project name (ee.String)', col.getString('project_name'));\n\n// Get the value of a numeric collection property as an ee.Number object.\nprint('Project year (ee.Number)', col.getNumber('project_year'));\n\n// Get the value of an ee.Array collection property as an ee.Array object.\nprint('Plot IDs (ee.Array)', col.getArray('plot_ids'));\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\nfrom pprint import pprint\n\n# A contrived, empty image collection for simple demonstration.\ncol = ee.ImageCollection([])\nprint('Collection without properties:')\npprint(col.getInfo())\n\n# Set collection properties using a dictionary.\ncol = col.set({\n 'project_name': 'biomass_tracking',\n 'project_id': 3,\n 'plot_ids': ee.Array([7, 11, 20])\n})\n\n# Set collection properties using a series of key-value pairs.\ncol = col.set('project_year', 2018,\n 'rgb_vis', 'false_color')\n\nprint('Collection with properties:')\npprint(col.getInfo())\n\n# Get a dictionary of collection property keys and values.\nprint('Property keys and values (ee.Dictionary):')\npprint(col.toDictionary().getInfo())\n\n# Get the value of a collection property. To use the result of\n# ee.ImageCollection.get in further computation, you need to cast it to the\n# appropriate class, for example, ee.Number(result) or ee.String(result).\nprint('Project ID (ambiguous object):', col.get('project_id').getInfo())\n\n# Get the value of a string collection property as an ee.String object.\nprint('Project name (ee.String):', col.getString('project_name').getInfo())\n\n# Get the value of a numeric collection property as an ee.Number object.\nprint('Project year (ee.Number):', col.getNumber('project_year').getInfo())\n\n# Get the value of an ee.Array collection property as an ee.Array object.\nprint('Plot IDs (ee.Array):', col.getArray('plot_ids').getInfo())\n```"]]