class suncalc.SunCalc
Available on all platforms
The SunCalc module allows to calculate sun position, sunlight phases (times for sunrise, sunset, dusk, etc.), moon position and lunar phase for the given location and time.
SunCalc was ported to Haxe by Robin ypid Schneider to allow using it in a planed rewrite of the opening hours library.
It is based on the JavaScript implementation created by Vladimir Agafonkin (@mourner) as a part of the SunCalc.net project.
Most calculations are based on the formulas given in the excellent Astronomy Answers articles about position of the sun and the planets. You can read about different twilight phases calculated by SunCalc in the Twilight article on Wikipedia.
Class Fields
static function addTime(angle:Float, riseName:String, setName:String):Void
Adds a custom time to the times configuration.
static function getMoonIllumination(date:Date):{phase:Float, fraction:Float, angle:Float}
Returns an object with the following properties:
- fraction: Illuminated fraction of the moon; varies from 0.0 (new moon) to 1.0 (full moon).
- phase: Moon phase; varies from 0.0 to 1.0, described below.
- angle: Midpoint angle in radians of the illuminated limb of the moon reckoned eastward from the north point of the disk;
the moon is waxing if the angle is negative, and waning if positive.
Moon phase value should be interpreted like this:
| Phase | Name |
|---|---|
| 0 | New Moon, Waxing Crescent |
| 0.25 | First Quarter, Waxing Gibbous |
| 0.5 | Full Moon, Waning Gibbous |
| 0.75 | Last Quarter, Waning Crescent |
static function getMoonPosition(date:Date, lat:Float, lng:Float):{distance:Float, azimuth:Float, altitude:Float}
Returns an object with the following properties:
- altitude: Moon altitude above the horizon in radians.
- azimuth: Moon azimuth in radians.
- distance: Distance to moon in kilometers.
static function getMoonTimes(date:Date, lat:Float, lng:Float, ?inUTC:Bool):Map<String, Dynamic>
Returns an object with the following properties:
- rise: Moon rise time as Date.
- set: Moon set time as Date.
- alwaysUp: true if the moon never rises/sets and is always above the horizon during the day.
- alwaysDown: true if the moon is always below the horizon.
By default, it will search for moon rise and set during local user's day (from 0 to 24 hours).
If inUTC is set to true, it will instead search the specified date from 0 to 24 UTC hours.
static function getPosition(date:Date, lat:Float, lng:Float):{azimuth:Float, altitude:Float}
Returns an object with the following properties:
altitude: Sun altitude above the horizon in radians,
e.g. 0 at the horizon and PI/2 at the zenith (straight over your head).
azimuth: Sun azimuth in radians (direction along the horizon, measured from south to west),
e.g. 0 is south and PI * 3/4 is northwest.
static function getTimes(date:Date, lat:Float, lng:Float):Map<String, Date>
Returns an object with the following properties (each is a Date object):
| Property | Description |
|---|---|
sunrise |
sunrise (top edge of the sun appears on the horizon) |
sunriseEnd |
sunrise ends (bottom edge of the sun touches the horizon) |
goldenHourEnd |
morning golden hour (soft light, best time for photography) ends |
solarNoon |
solar noon (sun is in the highest position) |
goldenHour |
evening golden hour starts |
sunsetStart |
sunset starts (bottom edge of the sun touches the horizon) |
sunset |
sunset (sun disappears below the horizon, evening civil twilight starts) |
dusk |
dusk (evening nautical twilight starts) |
nauticalDusk |
nautical dusk (evening astronomical twilight starts) |
night |
night starts (dark enough for astronomical observations) |
nadir |
nadir (darkest moment of the night, sun is in the lowest position) |
nightEnd |
night ends (morning astronomical twilight starts) |
nauticalDawn |
nautical dawn (morning nautical twilight starts) |
dawn |
dawn (morning nautical twilight ends, morning civil twilight starts) |