API Reference / ContextOptions · interface

Interface: ContextOptions

Properties

PropertyTypeDescription
<a id="composite"></a> composite?CompositePlacement[]Composite midpoint placements, e.g. from compositePlacements.
<a id="lots"></a> lots?{ house: number; lot: string; sign: string; signDeg: number; }[]Hermetic lots to project as lot atoms, e.g. from Engine.lots.
<a id="patterns"></a> patterns?ChartPattern[]Precomputed patterns/signature, to avoid recomputing them.
<a id="provenance"></a> provenance?{ certainty?: Certainty; realm?: Realm; }The chart's grounding. Carried onto the context; an inexact certainty damps time-sensitive atoms. Wire from realize's result.
provenance.certainty?Certainty-
provenance.realm?Realm-
<a id="salience"></a> salience?Partial<SalienceWeights>Salience weights to override (merged over DEFAULT_SALIENCE).
<a id="signature"></a> signature?ChartSignature-
<a id="stars"></a> stars?{ body: string; orb: number; star: string; }[]Fixed-star conjunctions to project as star atoms. The engine does not compute these from a bare Chart (the star catalog lives in the data pack), so a caller supplies them, e.g. from Engine.starConjunctions.
<a id="synastry"></a> synastry?{ aspects?: SynastryAspectHit[]; overlays?: SynastryOverlays; }Synastry aspects and/or house overlays between two charts.
synastry.aspects?SynastryAspectHit[]-
synastry.overlays?SynastryOverlays-
<a id="timelords"></a> timelords?{ dasha?: { antar?: string | null; maha: string; moon_nakshatra?: string; pratyantar?: string | null; }; firdaria?: { day?: boolean; major: string | null; sub: string | null; }; profection?: Profection; zr?: { l1: string; l2: string; l3: string; l4: string; lot?: string; }; }Active time-lord periods at a target instant (caller-supplied).
timelords.dasha?{ antar?: string | null; maha: string; moon_nakshatra?: string; pratyantar?: string | null; }-
timelords.dasha.antar?string | null-
timelords.dasha.mahastring-
timelords.dasha.moon_nakshatra?string-
timelords.dasha.pratyantar?string | null-
timelords.firdaria?{ day?: boolean; major: string | null; sub: string | null; }-
timelords.firdaria.day?boolean-
timelords.firdaria.majorstring | null-
timelords.firdaria.substring | null-
timelords.profection?Profection-
timelords.zr?{ l1: string; l2: string; l3: string; l4: string; lot?: string; }-
timelords.zr.l1string-
timelords.zr.l2string-
timelords.zr.l3string-
timelords.zr.l4string-
timelords.zr.lot?string-
<a id="transits"></a> transits?TransitHit[]Transit-to-natal hits, e.g. from transitAspects.
<a id="vedic"></a> vedic?{ nakshatraBodies?: string[]; vargas?: true | number[]; yogas?: { planets: string[]; yoga: string; }[]; }Vedic structure facts (caller-supplied or auto from sidereal chart).
vedic.nakshatraBodies?string[]Project nakshatras for these bodies from the chart longitudes.
vedic.vargas?true | number[]Project varga D-n for these bodies (default [9] when set true).
vedic.yogas?{ planets: string[]; yoga: string; }[]-

Start building

Quickstart →