ee.String.replace

  • The replace() method returns a new string with instances of a given pattern replaced by a specified replacement string.

  • It accepts a regular expression or a string to define the pattern to be replaced and the replacement string.

  • Optional flags can be used to control the behavior of the replacement, such as performing a global replacement ('g') or ignoring case ('i').

  • The method is available for Earth Engine String objects in both JavaScript and Python environments.

 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)

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