spacemap 0.1.4 → 0.1.6

package/index.d.ts

@@ -369,6 +369,10 @@ export declare function dateToJD(date: Date): number;
  *  renderer through the same effects a host's own store drives. */
 export declare function defaultSceneSettings(): SceneSettings;
 
+/** Kilometres between two places at `date`. Null and rejection are those of
+ *  {@link offsetKm}. */
+export declare function distanceKm(from: Anchor, to: Anchor, date: Date): Promise<number | null>;
+
 /**
  * A Keplerian orbit, propagated from its epoch by the mean motion the elements
  * carry. Defined at every date, so an object on one is always drawn.
@@ -1198,6 +1202,13 @@ export declare type NoticeTopic = Notice['topic'];
  *  ecliptic north pole. */
 export declare type OffsetKm = readonly [number, number, number];
 
+/**
+ * From one place to another at `date`, in kilometres on ecliptic J2000 axes.
+ * Null when either end is nowhere at that date. Rejects when the data does
+ * not load.
+ */
+export declare function offsetKm(from: Anchor, to: Anchor, date: Date): Promise<OffsetKm | null>;
+
 export declare interface OrbitalElements {
     a: number;
     e: number;
@@ -1587,6 +1598,9 @@ export declare interface PolylineOptions {
     widthPx?: number;
     /** 0 to 1. */
     opacity?: number;
+    /** A dash and a gap in screen pixels, written as the flat map takes them:
+     *  `"4 3"`. Solid when left out. */
+    dash?: string;
     /** Fade the line toward its last point, the way an orbit trail fades
      *  behind a body. */
     fade?: boolean;
@@ -2035,6 +2049,17 @@ export declare class SpaceMap {
      * is nothing to choose once a host has said what it looks like.
      */
     setBodyAppearance(id: string, appearance: BodyAppearance): this;
+    /**
+     * Keep these bodies in sight from however far: named, with their orbits,
+     * where the map would let a small or distant one drop out and would give
+     * its name up to a bigger neighbour's. A hidden layer does not take them
+     * either. An id the map has not loaded yet is pinned once it has. Each call
+     * replaces the last; an empty list gives the map its own judgement back.
+     *
+     * A moon is only drawn inside the system the camera is in, pinned or not:
+     * pin its planet to mark it from outside.
+     */
+    setPinnedBodies(ids: readonly string[]): this;
     /** A cap's radius as an angle, from whichever of the two ways the host gave
      *  it. A radius in kilometres needs the body's own radius, which an
      *  unloaded body has not published yet. */
@@ -2084,6 +2109,13 @@ export declare interface SpaceMapOptions {
     layers?: Partial<Record<MapLayerId, boolean>>;
 }
 
+/**
+ * The place on `id` where the Sun is overhead at `date`, in the frame of a
+ * surface anchor. Null for the Sun, and for a body that is nowhere at that
+ * date. Rejects when the data does not load.
+ */
+export declare function subsolarPoint(id: string, date: Date): Promise<LonLat | null>;
+
 /** A place on (or above) the body's surface, turning with it. */
 export declare interface SurfaceAnchor {
     body: string;
@@ -2114,6 +2146,9 @@ export declare interface SurfacePolygonOptions extends SurfaceShapeOptions {
 export declare interface SurfacePolylineOptions extends SurfaceShapeOptions {
     /** Join the last place back to the first. */
     closed?: boolean;
+    /** A dash and a gap in screen pixels, written as the flat map takes them:
+     *  `"4 3"`. Solid when left out. */
+    dash?: string;
 }
 
 /** A shape on a body's surface, for as long as the host keeps it. */