API Reference / MilkyWay · interface

Interface: MilkyWay

The Milky Way band's appearance in the frame. Visible only in a dark sky (astronomical twilight or night) without a bright Moon or heavy light pollution. The band is the galactic equator; its bright bulge is the galactic center in Sagittarius.

Properties

PropertyTypeDescription
<a id="entry"></a> entry| { x: number; y: number; } | nullPixel where the band enters the frame, and where it exits.
<a id="exit"></a> exit| { x: number; y: number; } | null-
<a id="galacticcenter"></a> galacticCenter| { altitudeDeg: number; inFrame: boolean; side: string; x: number; y: number; } | nullThe galactic center (Sagittarius), the brightest part, when above the horizon: its pixel, whether it is in frame, its altitude, and which way it lies relative to the frame.
<a id="inframe"></a> inFramebooleanThe band crosses the frame (implies visible).
<a id="note"></a> notestringPlain-language state, e.g. "crosses the frame, bright center in view" or "washed out by a bright Moon".
<a id="visible"></a> visiblebooleanDark enough to see, and at least partly above the horizon.

Start building

Quickstart →