ee.String.compareTo

  • The compareTo method lexicographically compares two strings.

  • It returns 0 if the strings are equal, -1 if the first string is less than the second, and 1 if the first string is greater than the second.

  • The method takes one string argument to compare against the invoking string object.

  • Examples are provided for both JavaScript and Python.

 Compares two strings lexicographically. Returns: the value 0 if the two strings are lexicographically equal; -1 if string1 is less than string2; and 1 if string1 is lexicographically greater than string2.

UsageReturns
String.compareTo(string2)Integer
ArgumentTypeDetails
this: string1StringThe string to compare.
string2StringThe string to be compared.

Examples

Code Editor (JavaScript)

print(ee.String('a').compareTo('b'));  // -1
print(ee.String('a').compareTo('a'));  // 0
print(ee.String('b').compareTo('a'));  // 1

print(ee.String('a').compareTo(ee.String('b')));  // -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)

print(ee.String('a').compareTo('b').getInfo())  # -1
print(ee.String('a').compareTo('a').getInfo())  # 0
print(ee.String('b').compareTo('a').getInfo())  # 1

print(ee.String('a').compareTo(ee.String('b')).getInfo())  # -1