API Reference / SyntheticBody · type

Type Alias: SyntheticBody

type SyntheticBody = 
  | {
  id: string;
  lonDeg: number;
  mode: "placement";
}
  | {
  epoch?: number;
  id: string;
  mode: "periodic";
  periodDays: number;
  phaseDeg: number;
}
  | {
  a: number;
  e: number;
  epoch?: number;
  i: number;
  id: string;
  M0: number;
  mode: "kepler";
  node: number;
  peri: number;
  periodDays: number;
};

A single authored body. Its id is how every consumer (charts, transits, SkyView) refers to it.

Union Members

Type Literal

{
  id: string;
  lonDeg: number;
  mode: "placement";
}

A fixed longitude that never moves — parity with compileForm.


Type Literal

{
  epoch?: number;
  id: string;
  mode: "periodic";
  periodDays: number;
  phaseDeg: number;
}

Uniform angular motion: lon(t) = phaseDeg + 360·(t − epoch)/periodDays. epoch defaults to 0.


Type Literal

{
  a: number;
  e: number;
  epoch?: number;
  i: number;
  id: string;
  M0: number;
  mode: "kepler";
  node: number;
  peri: number;
  periodDays: number;
}

Constant Keplerian elements. Angles i, node, peri, M0 in degrees; a in arbitrary length units (consistent within a system); e in [0, 1); epoch defaults to 0.

Start building

Quickstart →