API Reference / SkyViewOptions · interface

Interface: SkyViewOptions

Properties

PropertyTypeDescription
<a id="bodies"></a> bodies?BodyId[]Bodies to place. Defaults to Sun, Moon, and the naked-eye planets.
<a id="bortle"></a> bortle?numberBortle dark-sky class, 1 (pristine) to 9 (inner city). Sets the night naked-eye limit and drives the background star-field density and Milky Way visibility. Omit for the legacy suburban default (limit 6.0).
<a id="deepfield"></a> deepField?booleanPin the complete deep star field (needs the deep pack loaded). Defaults to on when the sky is dark and no bright Moon is up.
<a id="includestars"></a> includeStars?booleanInclude bright catalog stars. Defaults to true when a catalog is loaded.
<a id="maxstarmag"></a> maxStarMag?numberBrightest-magnitude cutoff for stars (smaller is brighter). Default 2.5.
<a id="maxstars"></a> maxStars?numberCap on the number of stars returned. Default 40 (named) or 4000 (deep).
<a id="overlays"></a> overlays?SkyViewOverlaysRequestReference-frame overlays to project onto the sky (annotations, not part of a photoreal render).
<a id="pressure"></a> pressure?numberAtmospheric pressure (hPa) and temperature (C) for refraction.
<a id="refraction"></a> refraction?booleanLift apparent altitudes by refraction. Defaults to true.
<a id="tempc"></a> tempC?number-

Start building

Quickstart →