ee.Dictionary.contains

  • The Dictionary.contains(key) method checks if a dictionary includes a specific key.

  • It takes the dictionary and the key (as a string) as arguments and returns a boolean value.

  • Examples in both JavaScript and Python demonstrate how to use the method and interpret the boolean output.

 Returns true if the dictionary contains the given key.

UsageReturns
Dictionary.contains(key)Boolean
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
});

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())