API Reference / Engine · class

Class: Engine

Defined in: chart.ts:115

Constructors

Constructor

new Engine(data): Engine;

Defined in: chart.ts:122

Parameters

data

EngineData

Returns

Engine

Properties

data

readonly data: EngineData;

Defined in: chart.ts:116

Methods

bodies()

bodies(): BodyId[];

Defined in: chart.ts:147

Body ids this engine can compute, given the data it was handed.

Returns

BodyId[]


chart()

chart(
   y, 
   mo, 
   d, 
   h, 
   mi, 
   s, 
   lat, 
   lonEast, 
   opts?): Chart;

Defined in: chart.ts:317

Full natal chart. Time is UT. East longitude positive. The ninth argument takes a house system name (0.2.x form) or a ChartOptions bag.

Parameters

y

number

mo

number

d

number

h

number

mi

number

s

number

lat

number

lonEast

number

opts?

| HouseSystem | ChartOptions

Returns

Chart


ecliptic()

ecliptic(body, jde): [number, number, number | null];

Defined in: chart.ts:158

Apparent geocentric [lon rad, lat rad, dist AU | null] at TT jde. Building block for the events module; chart consumers want position() instead.

Parameters

body

BodyId

jde

number

Returns

[number, number, number | null]


fixedStar()

fixedStar(
   name, 
   jdUt, 
   opts?): {
  dec: number;
  lat: number;
  lon: number;
  mag: number;
  ra: number;
  sign: string;
  signDeg: number;
};

Defined in: chart.ts:211

Apparent place of a catalog star: lon/lat/ra/dec (deg), sign, mag.

Parameters

name

string

jdUt

number

opts?

CalcOptions = {}

Returns

{
  dec: number;
  lat: number;
  lon: number;
  mag: number;
  ra: number;
  sign: string;
  signDeg: number;
}
dec
dec: number;
lat
lat: number;
lon
lon: number;
mag
mag: number;
ra
ra: number;
sign
sign: string;
signDeg
signDeg: number;

heliocentric()

heliocentric(body, jdUt): {
  dist: number;
  lat: number;
  lon: number;
};

Defined in: chart.ts:260

Geometric heliocentric ecliptic of date (deg, deg, AU).

Parameters

body

BodyId

jdUt

number

Returns

{
  dist: number;
  lat: number;
  lon: number;
}
dist
dist: number;
lat
lat: number;
lon
lon: number;

longitude()

longitude(
   body, 
   jdUt, 
   opts?): number;

Defined in: chart.ts:253

Apparent geocentric ecliptic longitude (deg). Tropical: true equinox of date. Sidereal: mean equinox minus ayanamsa.

Parameters

body

BodyId

jdUt

number

opts?

CalcOptions = {}

Returns

number


position()

position(
   body, 
   jdUt, 
   opts?): Position;

Defined in: chart.ts:288

Full position: lon/speed/retrograde/sign + lat, dist (AU), ra, dec.

Parameters

body

BodyId

jdUt

number

opts?

CalcOptions = {}

Returns

Position


starNames()

starNames(): string[];

Defined in: chart.ts:230

Names in the loaded fixed-star catalog (sorted).

Returns

string[]