spacemap 0.1.15 → 0.1.17

package/index.d.ts

@@ -390,8 +390,9 @@ export declare interface ElementsOptions {
     /** What the orbit is round; the Sun when left out. */
     body?: string;
     /** The export's own elements: `a` in astronomical units, angles in degrees,
-     *  `n` in degrees a day, `epoch` a Julian date. Set `equatorial` when the
-     *  angles are referenced to Earth's equator rather than the ecliptic. */
+     *  `n` in degrees a day, `epoch` a Julian date in TDB. Set `equatorial` when
+     *  the angles are referenced to Earth's equator rather than the ecliptic, as
+     *  in a TLE: `epoch` is then in UTC, as the TLE gives it. */
     elements: OrbitalElements;
 }
 
@@ -1103,6 +1104,12 @@ export declare interface MapEvents {
     loading: (loading: boolean) => void;
     /** Boot progress, 0 to 1, monotonic within one load. */
     progress: (fraction: number) => void;
+    /** The map is at rest. The camera does not move, and the view has every
+     *  picture, model, tile and terrain grid that it needs. The event fires once
+     *  each time that the map comes to rest after a change. The clock can run. A
+     *  covered map is not at rest. The catalogue points and the star background
+     *  do not count. */
+    idle: () => void;
     /** The data could not be loaded. The map stays mounted and empty. */
     error: (message: string) => void;
     /** The export was republished while this map was open: its data is now a
@@ -1237,9 +1244,10 @@ export declare interface Neighbours {
     next: Neighbour | null;
 }
 
-/** The entries before and after `current` on the same mission's traverse.
- *  The list is already mission-then-time ordered, so neighbours are adjacent
- *  rows until the mission changes. */
+/** The nearest entries before and after `current` on the same mission's
+ *  traverse that stand somewhere else. A rover often shoots many mosaics at
+ *  one stop, so the adjacent rows of the mission-then-time list are mostly
+ *  the same spot. */
 export declare function neighboursOf(entries: PanoramaEntry[], current: PanoramaEntry, radiusKm: number): Neighbours;
 
 export declare type Notice = OutOfRangeNotice | CoveragePauseNotice;
@@ -1265,6 +1273,8 @@ export declare interface OrbitalElements {
     w: number;
     ma: number;
     n: number;
+    /** Julian date of the elements: UTC for TLE elements (`equatorial`), as the
+     *  TLE gives it; TDB for the others, as the ephemerides give it. */
     epoch: number;
     /**
      * Secular drift rates (deg/day) applied to om and w. Populated for SPICE
@@ -1275,6 +1285,8 @@ export declare interface OrbitalElements {
     omDot?: number;
     wDot?: number;
     q?: number;
+    /** Julian date of perihelion passage, on the time scale of `epoch`. Only for
+     *  parabolic orbits. */
     tp?: number;
     /**
      * True when i/om/w are referenced to Earth's mean equator of J2000 instead of
@@ -1361,7 +1373,7 @@ export declare interface PanoramaEntry {
      *  `unknown` means the sphere sits at an arbitrary azimuth, so nothing
      *  may be drawn or written as a heading. The full set `export/panoramas.py`
      *  writes — a wider union would erase the literals and stop checking. */
-    orientation?: 'unknown' | 'caption-aligned' | 'matched to an archival sphere';
+    orientation?: 'unknown' | 'caption-aligned' | 'matched to an archival sphere' | 'matched to a controlled mosaic';
     /** `estimated` where the sphere's angular bounds were fitted to a
      *  published flat image rather than read from an archive label. */
     geometry?: 'estimated';
@@ -1459,13 +1471,14 @@ export declare class PanoramaView {
     /** Every panorama of the body, mission by mission in time order. */
     getPanoramas(): readonly PanoramaEntry[];
     getCurrent(): PanoramaEntry | null;
-    /** The panoramas before and after the current one on its traverse. */
+    /** The nearest panoramas before and after the current one that stand
+     *  elsewhere on its traverse. */
     getNeighbours(): Neighbours | null;
     /** Show a panorama: an entry from the list, its id, or its `time,lat,lon`
      *  key. Resolves once it is on screen; a newer call supersedes one still
      *  in flight. */
     open(target: PanoramaEntry | string): Promise<void>;
-    /** Open the previous or next panorama on the traverse, when there is one. */
+    /** Open the previous or next neighbour on the traverse, when there is one. */
     step(key: ArrowKey): Promise<void>;
     private byKey;
     getView(): PanoramaViewState;
@@ -2263,6 +2276,7 @@ export declare class SystemMap {
     private readonly names;
     private readonly grouping;
     private readonly zones;
+    private readonly rings;
     private readonly places;
     private targets;
     /** Bundles read for the bodies no map file places, by id; null where the
@@ -2344,6 +2358,12 @@ export declare interface SystemMapOptions {
     /** `inner-outer` turns the two belts into the doors of the two zones of
      *  small bodies; `belts` leaves them the scenery they are. */
     zones?: 'belts' | 'inner-outer';
+    /** `visible` spans a planetary system's rings band over only the rings
+     *  {@link createMap} shows: Saturn's stops at the F ring rather than the
+     *  E ring, and Jupiter's and Neptune's, too faint to see, have no band. It
+     *  reads the primary's bundle and ring profiles. `all`, the default, spans
+     *  every ring. */
+    rings?: 'all' | 'visible';
 }
 
 /**