API Reference / solarEclipseLimits · function
Function: solarEclipseLimits()
function solarEclipseLimits(engine, jd): EclipsePath | null;
Ground path of a solar eclipse at a Julian Day (UT): the central point and the north/south limits of totality (or annularity), with the path width. Marches perpendicular to the shadow's ground track out to the umbra edge -- where the Moon just fully covers (or is covered by) the Sun. Sample across the eclipse to trace the full path of totality.
Parameters
| Parameter | Type | Description |
|---|---|---|
engine | Engine | The engine used to evaluate positions. |
jd | number | Instant to evaluate, Julian Day (UT) -- typically a SolarEclipse.tMax for the path at greatest eclipse. |
Returns
EclipsePath | null
The EclipsePath, or null when no central eclipse exists
then (only a partial eclipse, or the axis misses the Earth).