ee.String.equals

  • The equals() method checks if a given string is lexicographically equal to another object.

  • It returns true if the target object is a string and has the same characters in the same order as the reference string, otherwise it returns false.

  • The method is case-sensitive, meaning "Abies grandis" is not equal to "abies grandis".

  • The equals() method can be used with both client-side (JavaScript) and server-side (Python) Earth Engine APIs.

 Checks for string equality with a given object. Returns true if the target is a string and is lexicographically equal to the reference, or false otherwise.

UsageReturns
String.equals(target)Boolean
ArgumentTypeDetails
this: referenceStringThe string to compare for equality.
targetObjectThe second object to check for equality.

Examples

Code Editor (JavaScript)

var sp = ee.String('Abies grandis');

print('"Abies grandis" equals "Abies grandis"?', sp.equals('Abies grandis'));
print('"Abies grandis" equals "abies grandis"?', sp.equals('abies grandis'));
print('"Abies grandis" equals "Thuja plicata"?', sp.equals('Thuja plicata'));

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)

sp = ee.String('Abies grandis')

print('"Abies grandis" equals "Abies grandis"?',
      sp.equals('Abies grandis').getInfo())
print('"Abies grandis" equals "abies grandis"?',
      sp.equals('abies grandis').getInfo())
print('"Abies grandis" equals "Thuja plicata"?',
      sp.equals('Thuja plicata').getInfo())