geomancy
Version:
Geomantic utilities
432 lines (267 loc) • 13.6 kB
Markdown
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [Chart](#chart)
- [clone](#clone)
- [getCompany](#getcompany)
- [getHouse](#gethouse)
- [getHouses](#gethouses)
- [getIndex](#getindex)
- [getIndicationWeight](#getindicationweight)
- [getIndications](#getindications)
- [getPartOfFortune](#getpartoffortune)
- [getSeeds](#getseeds)
- [getShield](#getshield)
- [getWayOfThePoint](#getwayofthepoint)
- [ChartSequence](#chartsequence)
- [set](#set)
- [get](#get)
- [getDaughter](#getdaughter)
- [getProjected](#getprojected)
- [addUnique](#addunique)
- [addWeights](#addweights)
- [getAspects](#getaspects)
- [getConjunctions](#getconjunctions)
- [getMutations](#getmutations)
- [getOccupation](#getoccupation)
- [getSprings](#getsprings)
- [getTranslations](#gettranslations)
- [getAttributeArray](#getattributearray)
- [makeAspectsFor](#makeaspectsfor)
- [houseRange](#houserange)
- [slugify](#slugify)
- [Figure](#figure)
- [byName](#byname)
- [byFlags](#byflags)
- [byElements](#byelements)
- [companion](#companion)
- [isSinisterOf](#issinisterof)
- [isDexterOf](#isdexterof)
## Chart
Base Geomancy Chart Model
**Parameters**
- `sequence` **([ChartSequence](#chartsequence) \| [array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** The starting set of mothers (optional, default `null`)
- `querent` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The 0-indexed house of the querent (optional, default `0`)
- `quesited` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The 0-indexed house of the quesited (optional, default `-1`)
### clone
Makes a copy of this chart.
Returns **[Chart](#chart)** clone of this chart
### getCompany
Get the house and type of company, if it exists.
**Parameters**
- `house` **(House | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** to check for company
Returns **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) | null)** if in company, then returns an object:
{house: index, company: companyType}
### getHouse
Get the specified house by index.
**Parameters**
- `index` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** position
Returns **House** at position
### getHouses
Get an array of all the houses from this chart.
Returns **[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** weighted total with positive numbers indicating success/true.
### getIndications
Gets the chart indications for the specified querest and quesited houses.
**Parameters**
- `querent` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** querent to use for this call (optional, default `this.querent`)
- `quesited` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** quesited to use for this call (optional, default `this.quesited`)
- `inCompany` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** flag to prevent endless recursion on companies (optional, default `false`)
**Examples**
```javascript
{
"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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** convert to slugs (optional, default `false`)
Returns **[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<House>** four mother houses
### getShield
Get the chart houses as a map
Returns **[Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)<[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** position
- `figure` **([Figure](#figure) \| [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** to set
Returns **null** nothing
### get
Get the figure at or projected to that index
**Parameters**
- `ix` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** position
Returns **[Figure](#figure)** figure at position
### getDaughter
Project the Daughter figures
**Parameters**
- `ix` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** position
Returns **[Figure](#figure)** daughter
### getProjected
Project any arbitrary higher position
**Parameters**
- `ix` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** position
Returns **[Figure](#figure)** at position
## addUnique
Adds unique values of one dictionary to another, appending to arrays, and walking sub-objects.
**Parameters**
- `dict` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** target object
- `added` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** merge object
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** merged dict
## addWeights
Adds up indication weights for a set of indications.
**Parameters**
- `dict` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Indications
- `inCompany` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if indication is due to a company
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** list of springs
- `houses` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<House>** list of chart houses
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Aspect set
## getConjunctions
Find conjunctions for a given set of houses.
**Parameters**
- `querent` **House** chart querent
- `quesited` **House** chart quesited
- `houses` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<House>** List of chart houses
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)<[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)>** Conjunctions
## getMutations
Find mutations for a given set of houses
**Parameters**
- `springs` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** list of springs
- `houses` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<House>** List of chart houses
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** list of mutations
## getOccupation
[getOccupation description]
**Parameters**
- `querent` **\[type]** [description]
- `quesited` **\[type]** [description]
Returns **\[type]** [description]
## getSprings
[getSprings description]
**Parameters**
- `querent` **\[type]** [description]
- `quesited` **\[type]** [description]
- `houses` **\[type]** [description]
Returns **\[type]** [description]
## getTranslations
[getTranslations description]
**Parameters**
- `querent` **\[type]** [description]
- `quesited` **\[type]** [description]
- `houses` **\[type]** [description]
Returns **\[type]** [description]
## getAttributeArray
walks an indications structure, returning an array of keyed values
**Parameters**
- `dict` **\[type]** [description]
- `member` **\[type]** [description]
Returns **\[type]** [description]
## makeAspectsFor
[makeAspectsFor description]
**Parameters**
- `aspects` **\[type]** [description]
- `querent` **\[type]** [description]
- `quesited` **\[type]** [description]
Returns **\[type]** [description]
## houseRange
Forces `x` into the range 0-11
**Parameters**
- `x` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** input
Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** safe number
## slugify
Converts a simple string into a slug for urls
**Parameters**
- `name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** to slugify
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** slugified version
## Figure
A Geomantic Figure
**Parameters**
- `flags` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** element flags
### byName
Gets one Figure by name.
**Parameters**
- `name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** to find
Returns **[Figure](#figure)** named figure
### byFlags
Gets one Figure by its Flags.
**Parameters**
- `flags` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** element flags
Returns **Fgure** figure with flags
### byElements
Gets a Figure by elements.
**Parameters**
- `elements` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)<[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** element dictionary
Returns **[Figure](#figure)** figure with specified flags.
## companion
returns the companion house index.
## isSinisterOf
returns whether 'other' is sinister to this House
**Parameters**
- `other` **(House | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** House or index of it
Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if this one is sinister to other one
## isDexterOf
returns whether 'other' is dexter to this House
**Parameters**
- `other` **(House | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** House or index of it
Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if this one is dexter to other one