ee.Date.getRelative

  • The getRelative method returns a 0-based unit of a date relative to a larger unit.

  • The method takes unit and inUnit string arguments to specify the units, and an optional timeZone argument.

  • The unit argument can be 'month', 'week', 'day', 'hour', 'minute', or 'second'.

  • The inUnit argument can be 'year', 'month', 'week', 'day', 'hour', or 'minute'.

  • If the unit argument is larger than the inUnit argument, the method returns 0.

 Returns the specified (0-based) unit of this date relative to a larger unit, e.g., getRelative('day', 'year') returns a value between 0 and 365.

UsageReturns
Date.getRelative(unit, inUnit, timeZone)Long
ArgumentTypeDetails
this: dateDate
unitStringOne of 'month', 'week', 'day', 'hour', 'minute', or 'second'.
inUnitStringOne of 'year', 'month', 'week', 'day', 'hour', or 'minute'.
timeZoneString, default: nullThe time zone (e.g., 'America/Los_Angeles'); defaults to UTC.

Examples

Code Editor (JavaScript)

var date = ee.Date('2021-4-30T07:15:31.24');

print('0-based month of year', date.getRelative('month', 'year'));
print('0-based week of year', date.getRelative('week', 'year'));
print('0-based day of year', date.getRelative('day', 'year'));
print('0-based day of month', date.getRelative('day', 'month'));
print('0-based minute of day', date.getRelative('minute', 'day'));
print('0-based second of minute', date.getRelative('second', 'minute'));

// 0 is returned when unit argument is larger than inUnit argument.
print('0-based year of month (bad form)', date.getRelative('year', 'month'));

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)

date = ee.Date('2021-4-30T07:15:31.24')

display('0-based month of year:', date.getRelative('month', 'year'))
display('0-based week of year:', date.getRelative('week', 'year'))
display('0-based day of year:', date.getRelative('day', 'year'))
display('0-based day of month:', date.getRelative('day', 'month'))
display('0-based minute of day:', date.getRelative('minute', 'day'))
display('0-based second of minute:', date.getRelative('second', 'minute'))

# 0 is returned when unit argument is larger than inUnit argument.
display('0-based year of month (bad form):', date.getRelative('year', 'month'))