Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.String.compareTo
Stay organized with collections
Save and categorize content based on your preferences.
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.
| Usage | Returns | String.compareTo(string2) | Integer |
| Argument | Type | Details | this: string1 | String | The string to compare. |
string2 | String | The 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
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-03-19 UTC.
[null,null,["Last updated 2024-03-19 UTC."],[[["\u003cp\u003e\u003ccode\u003ecompareTo\u003c/code\u003e lexicographically compares two strings, returning 0 if they are equal, -1 if the first string is less than the second, and 1 if the first string is greater than the second.\u003c/p\u003e\n"],["\u003cp\u003eThis method can be used on both client-side (JavaScript) and server-side (Python) Earth Engine environments and takes two string arguments for comparison.\u003c/p\u003e\n"],["\u003cp\u003eThe output is an Integer value (\u003ccode\u003e-1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, or \u003ccode\u003e1\u003c/code\u003e) representing the comparison results.\u003c/p\u003e\n"]]],[],null,["# ee.String.compareTo\n\nCompares 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.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------------------|---------|\n| String.compareTo`(string2)` | Integer |\n\n| Argument | Type | Details |\n|-----------------|--------|----------------------------|\n| this: `string1` | String | The string to compare. |\n| `string2` | String | The string to be compared. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint(ee.String('a').compareTo('b')); // -1\nprint(ee.String('a').compareTo('a')); // 0\nprint(ee.String('b').compareTo('a')); // 1\n\nprint(ee.String('a').compareTo(ee.String('b'))); // -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\nprint(ee.String('a').compareTo('b').getInfo()) # -1\nprint(ee.String('a').compareTo('a').getInfo()) # 0\nprint(ee.String('b').compareTo('a').getInfo()) # 1\n\nprint(ee.String('a').compareTo(ee.String('b')).getInfo()) # -1\n```"]]