TzolkinDay

Defined in: cr/component/tzolkinDay.ts:84

Describes only the day component of a 260-day cycle

Extends

• Cycle

Constructors

Constructor

new TzolkinDay(newName): TzolkinDay

Defined in: cr/component/tzolkinDay.ts:89

Parameters

newName

Name or position of the 260-day cycle day

string | number | Wildcard

Returns

TzolkinDay

Overrides

Cycle.constructor

Properties

position

position: number

Defined in: cr/component/cycle.ts:14

Absolute position within the linear cycle for this object.

Inherited from

Cycle.position

Methods

isWildcard()

isWildcard(): boolean

Defined in: cr/component/base.ts:11

Returns

boolean

Inherited from

Cycle.isWildcard

---

next()

next(): Cycle

Defined in: cr/component/cycle.ts:44

Return the next object in the cycle

Returns

Cycle

Inherited from

Cycle.next

---

shift()

shift(incremental): Cycle

Defined in: cr/component/cycle.ts:52

Move an incremental number of steps in the cycle, and return the object found there.

Parameters

incremental

number

The number of steps to move through in the cycle.

Returns

Cycle

Inherited from

Cycle.shift

---

toLocaleString()

toLocaleString(locale?): string

Defined in: cr/component/tzolkinDay.ts:98

Render the day name using i18n for the specified locale

Parameters

locale?

string

Optional locale to use for rendering (defaults to active locale)

Returns

string

The rendered day name

---

toString()

toString(): string

Defined in: cr/component/cycle.ts:80

Render this cycle object as a string

Returns

string

Inherited from

Cycle.toString

---

validate()

validate(): boolean

Defined in: cr/component/tzolkinDay.ts:109

Ensure the Tzolk'in day name is defined. Note: Validation is now locale-agnostic to support first-class i18n.

Returns

boolean

Overrides

Cycle.validate