Stay organized with collectionsSave and categorize content based on your preferences.
Convert a date to string.
Usage
Returns
Date.format(format,timeZone)
String
Argument
Type
Details
this:date
Date
format
String, default: null
A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html; if omitted will use ISO standard date formatting.
timeZone
String, default: null
The time zone (e.g., 'America/Los_Angeles'); defaults to UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-13 UTC."],[[["\u003cp\u003e\u003ccode\u003eee.Date.format()\u003c/code\u003e converts an Earth Engine \u003ccode\u003eDate\u003c/code\u003e object to a formatted string representation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eformat\u003c/code\u003e argument uses Joda-Time formatting patterns for customization.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etimeZone\u003c/code\u003e argument, if provided, adjusts the output to the specified time zone; defaults to UTC.\u003c/p\u003e\n"],["\u003cp\u003eIf \u003ccode\u003eformat\u003c/code\u003e is omitted, the ISO standard date formatting is used.\u003c/p\u003e\n"],["\u003cp\u003eJoda-Time formatting patterns provide flexible options to display various date and time components, including year, month, day, hour, minute, second, time zone, and more.\u003c/p\u003e\n"]]],["The `Date.format()` method converts a date to a string. It accepts a `format` string based on Joda-Time patterns and an optional `timeZone` string; if these arguments are omitted, the function will use default ISO formatting and UTC timezone. The method takes a date as input, and outputs a string representing the date, with specific formatting and time zone adjustments. The document also shows how to apply the formatting patterns.\n"],null,["# ee.Date.format\n\nConvert a date to string.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------|---------|\n| Date.format`(`*format* `, `*timeZone*`)` | String |\n\n| Argument | Type | Details |\n|--------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `date` | Date | |\n| `format` | String, default: null | A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html; if omitted will use ISO standard date formatting. |\n| `timeZone` | String, default: null | The time zone (e.g., 'America/Los_Angeles'); defaults to UTC. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Various examples of ee.Date.format with Joda-Time formatting and time zones.\n\nvar date = ee.Date('2020-08-18'); // Defaults to UTC\nprint(date); // Date (2020-08-18 00:00:00)\n\n// List of time zones:\n// https://www.joda.org/joda-time/timezones.html\n\nprint(date.format(null, 'GMT')); // 2020-08-18T00:00:00\nprint(date.format(null, 'Etc/GMT')); // 2020-08-18T00:00:00\nprint(date.format(null, 'Etc/GMT+0')); // 2020-08-18T00:00:00\nprint(date.format(null, 'Zulu')); // 2020-08-18T00:00:00\nprint(date.format(null, 'UTC')); // 2020-08-18T00:00:00\n\nprint(date.format(null, 'America/Los_Angeles')); // 2020-08-17T17:00:00\nprint(date.format(null, 'US/Pacific')); // 2020-08-17T17:00:00\nprint(date.format(null, 'Etc/GMT+8')); // 2020-08-17T17:00:00\nprint(date.format(null, 'PST8PDT')); // 2020-08-17T17:00:00\n\nprint(date.format(null, 'Australia/Tasmania')); // 2020-08-18T10:00:00\nprint(date.format(null, 'Etc/GMT-10')); // 2020-08-18T10:00:00\n\n// Reference for Joda-Time format characters:\n// https://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html\n\nvar datetime = ee.Date('1975-07-23T21:13:59'); // Defaults to UTC\nprint(datetime); // Date (1972-07-25 21:13:59)\n\n// year of era and era\nprint(datetime.format('YYYY GG')); // 1975 AD\n// century and year\nprint(datetime.format('CC YY')); // 19 75\n// weekyear and week of weekyear\nprint(datetime.format('xxxx ww')); // 1975 30\n\n// year and day of year\nprint(datetime.format('yy DDD')); // 75 204\n// month of year and day of month\nprint(datetime.format('MM dd')); // 07 23\n\n// day of week number and day of week text\nprint(datetime.format('e E')); // 3 Wed\nprint(datetime.format('e EEEEEEEE')); // 3 Wednesday\n\n// half of day, hour of halfday, and clockhour of halfday\nprint(datetime.format('a K h')); // PM 9 9\nprint(datetime.format('a KK hh')); // PM 09 09\n\n// hour of day, clockhour of day, minute, second, fraction of second\nprint(datetime.format('H k m s S')); // 21 21 13 59 0\nprint(datetime.format('HH kk mm ss SS')); // 21 21 13 59 00\n\n// time zone\nprint(datetime.format('z')); // UTC\nprint(datetime.format('zzzz')); // Coordinated Universal Time\nprint(datetime.format('z', 'PST8PDT')); // PDT\nprint(datetime.format('zzzz', 'PST8PDT')); // Pacific Daylight Time\n\n// time zone offset/id\nprint(datetime.format('Z')); // +0000\nprint(datetime.format('ZZ')); // +00:00\nprint(datetime.format('ZZZ')); // UTC\nprint(datetime.format('Z', 'PST8PDT')); // -0700\nprint(datetime.format('ZZ', 'PST8PDT')); // -07:00\nprint(datetime.format('ZZZ', 'PST8PDT')); // PST8PDT\n\n// single quotes for text\nprint(datetime.format(\"YY 'yada' MM\")); // 75 yada 07\n// '' for a single quote\nprint(datetime.format(\"YY ''MM'' dd\")); // 75 '07' 23\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\n# Various examples of ee.Date.format with Joda-Time formatting and time zones.\n\ndate = ee.Date('2020-08-18') # Defaults to UTC\ndisplay(date) # Date (2020-08-18 00:00:00)\n\n# List of time zones:\n# https://www.joda.org/joda-time/timezones.html\n\ndisplay(date.format(None, 'GMT')) # 2020-08-18T00:00:00\ndisplay(date.format(None, 'Etc/GMT')) # 2020-08-18T00:00:00\ndisplay(date.format(None, 'Etc/GMT+0')) # 2020-08-18T00:00:00\ndisplay(date.format(None, 'Zulu')) # 2020-08-18T00:00:00\ndisplay(date.format(None, 'UTC')) # 2020-08-18T00:00:00\n\ndisplay(date.format(None, 'America/Los_Angeles')) # 2020-08-17T17:00:00\ndisplay(date.format(None, 'US/Pacific')) # 2020-08-17T17:00:00\ndisplay(date.format(None, 'Etc/GMT+8')) # 2020-08-17T17:00:00\ndisplay(date.format(None, 'PST8PDT')) # 2020-08-17T17:00:00\n\ndisplay(date.format(None, 'Australia/Tasmania')) # 2020-08-18T10:00:00\ndisplay(date.format(None, 'Etc/GMT-10')) # 2020-08-18T10:00:00\n\n# Reference for Joda-Time format characters:\n# http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html\n\ndatetime = ee.Date('1975-07-23T21:13:59') # Defaults to UTC\ndisplay(datetime) # Date (1972-07-25 21:13:59)\n\n# year of era and era\ndisplay(datetime.format('YYYY GG')) # 1975 AD\n# century and year\ndisplay(datetime.format('CC YY')) # 19 75\n# weekyear and week of weekyear\ndisplay(datetime.format('xxxx ww')) # 1975 30\n\n# year and day of year\ndisplay(datetime.format('yy DDD')) # 75 204\n# month of year and day of month\ndisplay(datetime.format('MM dd')) # 07 23\n\n# day of week number and day of week text\ndisplay(datetime.format('e E')) # 3 Wed\ndisplay(datetime.format('e EEEEEEEE')) # 3 Wednesday\n\n# half of day, hour of halfday, and clockhour of halfday\ndisplay(datetime.format('a K h')) # PM 9 9\ndisplay(datetime.format('a KK hh')) # PM 09 09\n\n# hour of day, clockhour of day, minute, second, fraction of second\ndisplay(datetime.format('H k m s S')) # 21 21 13 59 0\ndisplay(datetime.format('HH kk mm ss SS')) # 21 21 13 59 00\n\n# time zone\ndisplay(datetime.format('z')) # UTC\ndisplay(datetime.format('zzzz')) # Coordinated Universal Time\ndisplay(datetime.format('z', 'PST8PDT')) # PDT\ndisplay(datetime.format('zzzz', 'PST8PDT')) # Pacific Daylight Time\n\n# time zone offset/id\ndisplay(datetime.format('Z')) # +0000\ndisplay(datetime.format('ZZ')) # +00:00\ndisplay(datetime.format('ZZZ')) # UTC\ndisplay(datetime.format('Z', 'PST8PDT')) # -0700\ndisplay(datetime.format('ZZ', 'PST8PDT')) # -07:00\ndisplay(datetime.format('ZZZ', 'PST8PDT')) # PST8PDT\n\n# single quotes for text\ndisplay(datetime.format(\"YY 'yada' MM\")) # 75 yada 07\n# '' for a single quote\ndisplay(datetime.format(\"YY ''MM'' dd\")) # 75 '07' 23\n```"]]