Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Dictionary.contains
Stay organized with collections
Save and categorize content based on your preferences.
Returns true if the dictionary contains the given key.
| Usage | Returns | Dictionary.contains(key) | Boolean |
| 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
});
print('Dictionary contains key "B1"?', dict.contains('B1'));
print('Dictionary contains key "Band_1"?', dict.contains('Band_1'));
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
})
print('Dictionary contains key "B1"?:', dic.contains('B1').getInfo())
print('Dictionary contains key "Band_1"?:', dic.contains('Band_1').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 2024-06-05 UTC.
[null,null,["Last updated 2024-06-05 UTC."],[[["\u003cp\u003eThe \u003ccode\u003econtains()\u003c/code\u003e method checks if a given key exists within a dictionary.\u003c/p\u003e\n"],["\u003cp\u003eIt returns \u003ccode\u003etrue\u003c/code\u003e if the key is present in the dictionary, and \u003ccode\u003efalse\u003c/code\u003e otherwise.\u003c/p\u003e\n"],["\u003cp\u003eThe method takes the dictionary and the key to search for as input.\u003c/p\u003e\n"],["\u003cp\u003eUsage involves calling the method on a dictionary object with the target key as an argument, resulting in a boolean output.\u003c/p\u003e\n"]]],[],null,["# ee.Dictionary.contains\n\nReturns true if the dictionary contains the given key.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------|---------|\n| Dictionary.contains`(key)` | Boolean |\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});\n\nprint('Dictionary contains key \"B1\"?', dict.contains('B1'));\nprint('Dictionary contains key \"Band_1\"?', dict.contains('Band_1'));\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})\n\nprint('Dictionary contains key \"B1\"?:', dic.contains('B1').getInfo())\nprint('Dictionary contains key \"Band_1\"?:', dic.contains('Band_1').getInfo())\n```"]]