API Reference / SolarLocal · interface
Interface: SolarLocal
Local circumstances of a solar eclipse seen from one place.
Properties
| Property | Type | Description |
|---|---|---|
<a id="c1"></a> c1 | number | null | First contact (partial begins), JD UT, or null when unseen. |
<a id="c2"></a> c2 | number | null | Second contact (totality/annularity begins), JD UT, or null. |
<a id="c3"></a> c3 | number | null | Third contact (totality/annularity ends), JD UT, or null. |
<a id="c4"></a> c4 | number | null | Fourth contact (partial ends), JD UT, or null when unseen. |
<a id="magnitude"></a> magnitude | number | Eclipse magnitude: fraction of the Sun's diameter covered at maximum (can exceed 1 in totality). 0 when type is "none". |
<a id="maxtime"></a> maxTime | number | null | Time of maximum eclipse at this place (JD UT), or null when unseen. |
<a id="obscuration"></a> obscuration | number | Obscuration: fraction of the Sun's area covered at maximum, in [0, 1]. |
<a id="type"></a> type | "none" | "total" | "partial" | "annular" | What the observer sees at maximum: "none" when no part of the Sun is covered from this place. |