Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Number.mod

  • Themod method calculates the remainder of the first number divided by the second number.

  • The method takes two Number arguments,this: left andright, and returns a Number.

  • Examples are provided demonstrating the use of themod method in both JavaScript and Python for both positive and negative dividends.

 Calculates the remainder of the first value divided by the second.

UsageReturns
Number.mod(right)Number
ArgumentTypeDetails
this:leftNumberThe left-hand value.
rightNumberThe right-hand value.

Examples

Code Editor (JavaScript)

// Remainder with positive dividend.print('Remainder of 12/5',ee.Number(12).mod(ee.Number(5)));// 2print('Remainder of 1/-2',ee.Number(1).mod(ee.Number(-2)));// 1print('Remainder of 1/2',ee.Number(1).mod(ee.Number(2)));// 1print('Remainder of 2/3',ee.Number(2).mod(ee.Number(3)));// 2print('Remainder of 5.5/2',ee.Number(5.5).mod(ee.Number(2)));// 1.5// Remainder with negative dividend.print('Remainder of -12/5',ee.Number(-12).mod(ee.Number(5)));// -2print('Remainder of -1/2',ee.Number(-1).mod(ee.Number(2)));// -1print('Remainder of -4/2',ee.Number(-4).mod(ee.Number(2)));// 0

Python setup

See the Python Environment page for information on the Python API and usinggeemap for interactive development.

importeeimportgeemap.coreasgeemap

Colab (Python)

# Remainder with positive dividend.display('Remainder of 12/5:',ee.Number(12).mod(ee.Number(5)))# 2display('Remainder of 1/-2:',ee.Number(1).mod(ee.Number(-2)))# 1display('Remainder of 1/2:',ee.Number(1).mod(ee.Number(2)))# 1display('Remainder of 2/3:',ee.Number(2).mod(ee.Number(3)))# 2display('Remainder of 5.5/2:',ee.Number(5.5).mod(ee.Number(2)))# 1.5# Remainder with negative dividend.display('Remainder of -12/5:',ee.Number(-12).mod(ee.Number(5)))# -2display('Remainder of -1/2:',ee.Number(-1).mod(ee.Number(2)))# -1display('Remainder of -4/2:',ee.Number(-4).mod(ee.Number(2)))# 0

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-10-06 UTC.