Siddhanta Parity API Documentation - v1.3.0
    Preparing search index...

    Reports the time and geographic location of the peak of a solar eclipse.

    Returned by SearchGlobalSolarEclipse or NextGlobalSolarEclipse to report information about a solar eclipse event.

    The eclipse is classified as partial, annular, or total, depending on the maximum amount of the Sun's disc obscured, as seen at the peak location on the surface of the Earth.

    The kind field thus holds one of the values EclipseKind.Partial, EclipseKind.Annular, or EclipseKind.Total. A total eclipse is when the peak observer sees the Sun completely blocked by the Moon. An annular eclipse is like a total eclipse, but the Moon is too far from the Earth's surface to completely block the Sun; instead, the Sun takes on a ring-shaped appearance. A partial eclipse is when the Moon blocks part of the Sun's disc, but nobody on the Earth observes either a total or annular eclipse.

    If kind is EclipseKind.Total or EclipseKind.Annular, the latitude and longitude fields give the geographic coordinates of the center of the Moon's shadow projected onto the daytime side of the Earth at the instant of the eclipse's peak. If kind has any other value, latitude and longitude are undefined and should not be used.

    For total or annular eclipses, the obscuration field holds the fraction (0, 1] of the Sun's apparent disc area that is blocked from view by the Moon's silhouette, as seen by an observer located at the geographic coordinates latitude, longitude at the darkest time peak. The value will always be 1 for total eclipses, and less than 1 for annular eclipses. For partial eclipses, obscuration is undefined and should not be used. This is because there is little practical use for an obscuration value of a partial eclipse without supplying a particular observation location. Developers who wish to find an obscuration value for partial solar eclipses should therefore use SearchLocalSolarEclipse and provide the geographic coordinates of an observer.

    Index

    Constructors

    Properties

    distance: number

    The distance in kilometers between the axis of the Moon's shadow cone and the center of the Earth at the time indicated by peak.

    One of the following enumeration values: EclipseKind.Partial, EclipseKind.Annular, EclipseKind.Total.

    latitude?: number

    If kind holds EclipseKind.Total, the geographic latitude in degrees where the center of the Moon's shadow falls on the Earth at the time indicated by peak; otherwise, latitude holds undefined.

    longitude?: number

    If kind holds EclipseKind.Total, the geographic longitude in degrees where the center of the Moon's shadow falls on the Earth at the time indicated by peak; otherwise, longitude holds undefined.

    obscuration: number | undefined

    The peak fraction of the Sun's apparent disc area obscured by the Moon (total and annular eclipses only)

    peak: AstroTime

    The date and time when the solar eclipse is darkest. This is the instant when the axis of the Moon's shadow cone passes closest to the Earth's center.