geomancy/API.md at master · bkroeze/geomancy

Chart
ChartSequence
- set
- get
- getDaughter
- getProjected
addUnique
addWeights
getAspects
getConjunctions
getMutations
getOccupation
getSprings
getTranslations
getAttributeArray
makeAspectsFor
houseRange
slugify
Figure
companion
isSinisterOf
isDexterOf

Chart

Base Geomancy Chart Model

Parameters

sequence (ChartSequence | array) The starting set of mothers (optional, default null)
querent number The 0-indexed house of the querent (optional, default 0)
quesited number The 0-indexed house of the quesited (optional, default -1)

clone

Makes a copy of this chart.

Returns Chart clone of this chart

getCompany

Get the house and type of company, if it exists.

Parameters

house (House | number) to check for company

Returns (Object | null) if in company, then returns an object: {house: index, company: companyType}

getHouse

Get the specified house by index.

Parameters

index number position

Returns House at position

getHouses

Get an array of all the houses from this chart.

Returns array all 12 houses, note that the array is 0-indexed

getIndex

Find the Geomantic "index" of a chart.

Returns House at index

getIndicationWeight

Calculate and return the total "indication" weight for this chart.

Returns number weighted total with positive numbers indicating success/true.

getIndications

Gets the chart indications for the specified querest and quesited houses.

Parameters

querent number querent to use for this call (optional, default this.querent)
quesited number quesited to use for this call (optional, default this.quesited)
inCompany boolean flag to prevent endless recursion on companies (optional, default false)

Examples

{
 "springs": {
   "querent": [
     {
       "from": 1,
       "to": 4
     }
   ],
   "quesited": []
 },
 "occupations": [],
 "conjunctions": {
   "querent": [],
   "quesited": []
 },
 "mutations": [],
 "translations": [
   {
     "querent": 11,
     "quesited": 8,
     "weight": 3
   }
 ],
 "trines": [],
 "squares": [
   {
     "direction": "sinister",
     "querent": 4,
     "quesited": 7,
     "weight": -4
   }
 ],
 "oppositions": [],
 "sextiles": [
   {
     "direction": "sinister",
     "querent": 4,
     "quesited": 6,
     "weight": 2
   }
 ]
}

Returns Object a dictionary of Indications

getPartOfFortune

Find and return the house for the part of fortune.

Returns House Part of Fortune

getSeeds

Get the mothers as an array.

Parameters

slugify Boolean convert to slugs (optional, default false)

Returns array<House> four mother houses

getShield

Get the chart houses as a map

Returns Map<String, House> Shield houses keyed by name in the shield

getWayOfThePoint

Return the way of the point as an array, if it exists.

Returns Array<Number> Array of indexes of points in the way

ChartSequence

A sequence of geomantic figures, which is seeded by the first four houses, and projects all the rest from them.

Parameters

args ...any

set

Set the Figure at slot ix

Parameters

ix number position
figure (Figure | string) to set

Returns null nothing

get

Get the figure at or projected to that index

Parameters

ix number position

Returns Figure figure at position

getDaughter

Project the Daughter figures

Parameters

ix Number position

Returns Figure daughter

getProjected

Project any arbitrary higher position

Parameters

ix Number position

Returns Figure at position

addUnique

Adds unique values of one dictionary to another, appending to arrays, and walking sub-objects.

Parameters

dict Object target object
added Object merge object

Returns Object merged dict

addWeights

Adds up indication weights for a set of indications.

Parameters

dict Object Indications
inCompany Boolean true if indication is due to a company

Returns Object indications with weights

getAspects

Get all trines, squares, oppositions, and sextiles from a set of houses, including those caused by springs.

Parameters

initialQuerent House base querent
initialQuesited House base quesited
springs Array<Object> list of springs
houses Array<House> list of chart houses

Returns Object Aspect set

getConjunctions

Find conjunctions for a given set of houses.

Parameters

querent House chart querent
quesited House chart quesited
houses Array<House> List of chart houses

Returns Object<String, Array> Conjunctions

getMutations

Find mutations for a given set of houses

Parameters

springs Array<Object> list of springs
houses Array<House> List of chart houses

Returns Array<Object> list of mutations