Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.String.split
Stay organized with collections
Save and categorize content based on your preferences.
Splits a string on a regular expression, Returning a list of strings.
Usage | Returns | String.split(regex, flags) | List |
Argument | Type | Details | this: string | String | The string to split. |
regex | String | A regular expression to split on. If regex is the empty string, then the input string is split into individual characters. |
flags | String, default: "" | A string specifying the regular expression flag: 'i' (ignore case). |
Examples
Code Editor (JavaScript)
var s = ee.String('aBAbcD');
print(s.split('Ab')); // ["aB","cD"]
// 'i' tells split to ignore case.
print(s.split('ab', 'i')); // ["","","cD"]
// Split on 'b' or 'c'
print(s.split('[bc]', 'i')); // ["a","A","","D"]
// Split on 'BA' or 'c'
print(s.split('(BA|c)')); // ["a","b","D"]
var s = ee.String('a,b,cdee f,g');
// ["a",",","b",",","c","d","e","e"," ","f",",","g"]
print(s.split(''));
print(s.split(' ')); // ["a,b,cdee","f,g"]
print(s.split('[[:space:]]')); // ["a,b,cdee","f,g"]
print(s.split(',')); // ["a","b","cdee f","g"]
print(s.split('ee')); // ["a,b,cd"," f,g"]
// Split on any lower case letter.
print(s.split('[a-z]')); // ["",",",",","","",""," ",","]
// ^ as the first character in [] excludes.
print(s.split('[^a-z]')); // ["a","b","cdee","f","g"]
// Splitting on characters that are special to split.
var s = ee.String('a.b*c?d');
print(s.split('\\.')); // ["a","b*c?d"]
print(s.split('[*]')); // ["a.b","c?d"]
print(s.split('[?]')); // ["a.b*c","d"]
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('aBAbcD')
print(s.split('Ab').getInfo()) # ['aB', 'cD']
# 'i' tells split to ignore case.
print(s.split('ab', 'i').getInfo()) # ['', '', 'cD']
# Split on 'b' or 'c'
print(s.split('[bc]', 'i').getInfo()) # ['a', 'A', '', 'D']
# Split on 'BA' or 'c'
print(s.split('(BA|c)').getInfo()) # ['a', 'b', 'D']
s = ee.String('a,b,cdee f,g')
# ['a', ',', 'b', ',', 'c', 'd', 'e', 'e', ' ', 'f', ',', 'g']
print(s.split('').getInfo())
print(s.split(' ').getInfo()) # ['a,b,cdee', 'f,g']
print(s.split('[[:space:]]').getInfo()) # ['a,b,cdee', 'f,g']
print(s.split(',').getInfo()) # ['a', 'b', 'cdee f', 'g']
print(s.split('ee').getInfo()) # ['a,b,cd', ' f,g']
# Split on any lower case letter.
print(s.split('[a-z]').getInfo()) # ['', ',', ',', '', '', '', ' ', ',']
# ^ as the first character in [] excludes.
print(s.split('[^a-z]').getInfo()) # ['a', 'b', 'cdee', 'f', 'g']
# Splitting on characters that are special to split.
s = ee.String('a.b*c?d')
print(s.split('\\.').getInfo()) # ['a', 'b*c?d']
print(s.split('[*]').getInfo()) # ['a.b', 'c?d']
print(s.split('[?]').getInfo()) # ['a.b*c', 'd']
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\u003e\u003ccode\u003eString.split()\u003c/code\u003e divides a string into a list of substrings based on a provided regular expression.\u003c/p\u003e\n"],["\u003cp\u003eThe function accepts an optional \u003ccode\u003eflags\u003c/code\u003e argument, supporting 'i' for case-insensitive splitting.\u003c/p\u003e\n"],["\u003cp\u003eIf the regular expression is an empty string, the input string is split into individual characters.\u003c/p\u003e\n"],["\u003cp\u003eSpecial characters within the regular expression can be escaped using a backslash.\u003c/p\u003e\n"]]],[],null,["# ee.String.split\n\nSplits a string on a regular expression, Returning a list of strings.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------------|---------|\n| String.split`(regex, `*flags*`)` | List |\n\n| Argument | Type | Details |\n|----------------|---------------------|----------------------------------------------------------------------------------------------------------------------------|\n| this: `string` | String | The string to split. |\n| `regex` | String | A regular expression to split on. If regex is the empty string, then the input string is split into individual characters. |\n| `flags` | String, default: \"\" | A string specifying the regular expression flag: 'i' (ignore case). |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nvar s = ee.String('aBAbcD');\nprint(s.split('Ab')); // [\"aB\",\"cD\"]\n// 'i' tells split to ignore case.\nprint(s.split('ab', 'i')); // [\"\",\"\",\"cD\"]\n// Split on 'b' or 'c'\nprint(s.split('[bc]', 'i')); // [\"a\",\"A\",\"\",\"D\"]\n// Split on 'BA' or 'c'\nprint(s.split('(BA|c)')); // [\"a\",\"b\",\"D\"]\n\nvar s = ee.String('a,b,cdee f,g');\n// [\"a\",\",\",\"b\",\",\",\"c\",\"d\",\"e\",\"e\",\" \",\"f\",\",\",\"g\"]\nprint(s.split(''));\n\nprint(s.split(' ')); // [\"a,b,cdee\",\"f,g\"]\nprint(s.split('[[:space:]]')); // [\"a,b,cdee\",\"f,g\"]\n\nprint(s.split(',')); // [\"a\",\"b\",\"cdee f\",\"g\"]\n\nprint(s.split('ee')); // [\"a,b,cd\",\" f,g\"]\n\n// Split on any lower case letter.\nprint(s.split('[a-z]')); // [\"\",\",\",\",\",\"\",\"\",\"\",\" \",\",\"]\n\n// ^ as the first character in [] excludes.\nprint(s.split('[^a-z]')); // [\"a\",\"b\",\"cdee\",\"f\",\"g\"]\n\n// Splitting on characters that are special to split.\nvar s = ee.String('a.b*c?d');\nprint(s.split('\\\\.')); // [\"a\",\"b*c?d\"]\nprint(s.split('[*]')); // [\"a.b\",\"c?d\"]\nprint(s.split('[?]')); // [\"a.b*c\",\"d\"]\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('aBAbcD')\nprint(s.split('Ab').getInfo()) # ['aB', 'cD']\n# 'i' tells split to ignore case.\nprint(s.split('ab', 'i').getInfo()) # ['', '', 'cD']\n# Split on 'b' or 'c'\nprint(s.split('[bc]', 'i').getInfo()) # ['a', 'A', '', 'D']\n# Split on 'BA' or 'c'\nprint(s.split('(BA|c)').getInfo()) # ['a', 'b', 'D']\n\ns = ee.String('a,b,cdee f,g')\n# ['a', ',', 'b', ',', 'c', 'd', 'e', 'e', ' ', 'f', ',', 'g']\nprint(s.split('').getInfo())\n\nprint(s.split(' ').getInfo()) # ['a,b,cdee', 'f,g']\nprint(s.split('[[:space:]]').getInfo()) # ['a,b,cdee', 'f,g']\n\nprint(s.split(',').getInfo()) # ['a', 'b', 'cdee f', 'g']\n\nprint(s.split('ee').getInfo()) # ['a,b,cd', ' f,g']\n\n# Split on any lower case letter.\nprint(s.split('[a-z]').getInfo()) # ['', ',', ',', '', '', '', ' ', ',']\n\n# ^ as the first character in [] excludes.\nprint(s.split('[^a-z]').getInfo()) # ['a', 'b', 'cdee', 'f', 'g']\n\n# Splitting on characters that are special to split.\ns = ee.String('a.b*c?d')\nprint(s.split('\\\\.').getInfo()) # ['a', 'b*c?d']\nprint(s.split('[*]').getInfo()) # ['a.b', 'c?d']\nprint(s.split('[?]').getInfo()) # ['a.b*c', 'd']\n```"]]