ee.String.index

  • Searches a string for the first occurrence of a substring.

  • Returns the index of the first match or -1 if not found.

  • The search is case-sensitive.

 Searches a string for the first occurrence of a substring. Returns the index of the first match, or -1.

UsageReturns
String.index(pattern)Integer
ArgumentTypeDetails
this: targetStringThe string to search.
patternStringThe string to find.

Examples

Code Editor (JavaScript)

print(ee.String('abc123').index(''));  // 0
print(ee.String('abc123').index('c1'));  // 2
print(ee.String('abc123').index('ZZ'));  // -1

// index is case-sensitive.
print(ee.String('abc123').index('BC'));  // -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)

display(ee.String('abc123').index(''))  # 0
display(ee.String('abc123').index('c1'))  # 2
display(ee.String('abc123').index('ZZ'))  # -1

# index is case-sensitive.
display(ee.String('abc123').index('BC'))  # -1