ee.String.replace

  • The String.replace method returns a new string with some or all matches of a pattern replaced.

  • It takes a regular expression (regex), a replacement string, and optional flags ('g' for global, 'i' for ignore case) as arguments.

  • The method can be used to replace a specific occurrence or all occurrences of a pattern within a string.

 Returns a new string with some or all matches of a pattern replaced.

UsageReturns
String.replace(regex, replacement, flags)String
ArgumentTypeDetails
this: inputStringThe string in which to search.
regexStringThe regular expression to match.
replacementStringThe string that replaces the matched substring.
flagsString, default: ""A string specifying a combination of regular expression flags, specifically one or more of: 'g' (global match) or 'i' (ignore case)

Examples

Code Editor (JavaScript)

print(ee.String('abc-abc').replace('abc', 'X'));  // X-abc
print(ee.String('abc-abc').replace('abc', 'X', 'g'));  // X-X
print(ee.String('abc-abc').replace('abc', '', 'g'));  // -
print(ee.String('aBc-Abc').replace('abc', 'Z', 'i'));  // Z-Abc
print(ee.String('aBc-Abc').replace('abc', 'Z', 'ig'));  // Z-Z

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('abc-abc').replace('abc', 'X'))  # X-abc
display(ee.String('abc-abc').replace('abc', 'X', 'g'))  # X-X
display(ee.String('abc-abc').replace('abc', '', 'g'))  # -
display(ee.String('aBc-Abc').replace('abc', 'Z', 'i'))  # Z-Abc
display(ee.String('aBc-Abc').replace('abc', 'Z', 'ig'))  # Z-Z