Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.String.match
Stay organized with collections
Save and categorize content based on your preferences.
Matches a string against a regular expression. Returns a list of matching strings.
| Usage | Returns | String.match(regex, flags) | List |
| Argument | Type | Details | this: input | String | The string in which to search. |
regex | String | The regular expression to match. |
flags | String, 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)
var s = ee.String('ABCabc123');
print(s.match('')); // ""
print(s.match('ab', 'g')); // ab
print(s.match('ab', 'i')); // AB
print(s.match('AB', 'ig')); // ["AB","ab"]
print(s.match('[a-z]+[0-9]+')); // "abc123"
print(s.match('\\d{2}')); // "12"
// Use [^] to match any character except a digit.
print(s.match('abc[^0-9]', 'i')); // ["ABCa"]
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)
s = ee.String('ABCabc123')
print(s.match('').getInfo()) # ""
print(s.match('ab', 'g').getInfo()) # ab
print(s.match('ab', 'i').getInfo()) # AB
print(s.match('AB', 'ig').getInfo()) # ['AB','ab']
print(s.match('[a-z]+[0-9]+').getInfo()) # 'abc123'
print(s.match('\\d{2}').getInfo()) # '12'
# Use [^] to match any character except a digit.
print(s.match('abc[^0-9]', 'i').getInfo()) # ['ABCa']
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-07-13 UTC.
[null,null,["Last updated 2024-07-13 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eString.match()\u003c/code\u003e method searches a string for a specified regular expression and returns a list of matches.\u003c/p\u003e\n"],["\u003cp\u003eIt accepts the input string, the regular expression pattern, and optional flags ('g' for global match and 'i' for case-insensitive search).\u003c/p\u003e\n"],["\u003cp\u003eIf a match is found, the method returns a list containing the matching substring(s); otherwise, it returns an empty list.\u003c/p\u003e\n"],["\u003cp\u003eYou can use various regular expression patterns and flags to control the matching behavior, including character classes, quantifiers, and anchors.\u003c/p\u003e\n"]]],["The `String.match()` function searches a string (`input`) for matches to a given regular expression (`regex`). It returns a list of matching strings. Optional flags (`flags`) modify the search, such as 'g' for global matching or 'i' for case-insensitive matching. The examples demonstrate various regex patterns and flag combinations. The function returns an empty string if the pattern is empty, or list of matching strings when successful. The examples cover the use case for Javascript and Python.\n"],null,["# ee.String.match\n\nMatches a string against a regular expression. Returns a list of matching strings.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------------|---------|\n| String.match`(regex, `*flags*`)` | List |\n\n| Argument | Type | Details |\n|---------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| this: `input` | String | The string in which to search. |\n| `regex` | String | The regular expression to match. |\n| `flags` | String, default: \"\" | A string specifying a combination of regular expression flags, specifically one or more of: 'g' (global match) or 'i' (ignore case). |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nvar s = ee.String('ABCabc123');\nprint(s.match('')); // \"\"\nprint(s.match('ab', 'g')); // ab\nprint(s.match('ab', 'i')); // AB\nprint(s.match('AB', 'ig')); // [\"AB\",\"ab\"]\nprint(s.match('[a-z]+[0-9]+')); // \"abc123\"\nprint(s.match('\\\\d{2}')); // \"12\"\n\n// Use [^] to match any character except a digit.\nprint(s.match('abc[^0-9]', 'i')); // [\"ABCa\"]\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\ns = ee.String('ABCabc123')\nprint(s.match('').getInfo()) # \"\"\nprint(s.match('ab', 'g').getInfo()) # ab\nprint(s.match('ab', 'i').getInfo()) # AB\nprint(s.match('AB', 'ig').getInfo()) # ['AB','ab']\nprint(s.match('[a-z]+[0-9]+').getInfo()) # 'abc123'\nprint(s.match('\\\\d{2}').getInfo()) # '12'\n\n# Use [^] to match any character except a digit.\nprint(s.match('abc[^0-9]', 'i').getInfo()) # ['ABCa']\n```"]]