API Reference

Enumerations

Enumeration	Description
HaabMonths	-
TzolkinDays	-

Classes

Class	Description
Base	-
CalendarRound	A combination of 260-day cycles and the Haab cycle. This class should not be instantiated directly, and should be accessed through getCalendarRound.
CalendarRoundFactory	Parses Calendar Round strings into concrete objects.
CalendarRoundIterator	-
CalendarRoundWildcard	Expand a Calendar Round containing wildcards into all valid combinations.
Comment	Represents a free form comment that can be attached to many structures.
CommentWrapper	Mixin providing comment functionality for domain objects.
CorrelationConstant	Correlation Constant to align Long Counts with Western Calendars
Cycle	-
DistanceNumber	Minimal interface used for equality comparison across calendar components.
Factory	An abstract class to handle the create of an object from a string
FullDate	Minimal interface used for equality comparison across calendar components.
FullDateFactory	Given a fullDate composed of a Long Count and a Calendar Round, create a FullDate object.
FullDateWildcard	Expand a partial FullDate into all valid permutations.
GregorianCalendarDate	Represent a Gregorian date.
GregorianFactory	Factory for creating GregorianCalendarDate instances from Gregorian date strings.
Haab	Describes a Haab fullDate with a position and a month
HaabMonth	Haab month component of a Calendar Round date.
HashMap	Simple bidirectional map used to translate between indexes and values.
I18nManager	Manages internationalization for Maya calendar terms.
JulianCalendarDate	Represent a Julian date.
LongCount	Long Count cycle.
LongcountAddition	Base class for operations that manipulate LongCount values.
LongCountFactory	Parses textual representations of Long Count dates.
LongcountOperation	Base class for operations that manipulate LongCount values.
LongcountSubtraction	Base class for operations that manipulate LongCount values.
LongCountWildcard	Expand a LongCount containing wildcards into all valid dates.
LordOfTheNight	Describes one of the 9 Lords of the night. This class is accessible through its instantiated values, or the get() method.
NumberCoefficient	-
Tzolkin	Describes a fullDate in the 260-day cycle with a position and a day
TzolkinDay	Describes only the day component of a 260-day cycle
WesternCalendar	-
Wildcard	Minimal interface used for equality comparison across calendar components.
WildcardCoefficient	-

Interfaces

Interface	Description
HaabMonthTranslations	Translation registry for Haab month names
I18nRenderOptions	Options for rendering dates with i18n
ICoefficient	-
IComponent	-
ILongcount	-
IPart	Minimal interface used for equality comparison across calendar components.
LocaleDefinition	Complete locale definition
Translation	Translation mapping for a single term
TzolkinDayTranslations	Translation registry for Tzolkin day names

Type Aliases

Type Alias	Description
Locale	Locale identifier for i18n support

Variables

Variable	Description
calendarRoundOrigin	The Calendar Round base date: 4 Ajaw 8 Kumk'u.
DEFAULT_LOCALE	Default locale identifier
HAAB_MONTH_NAMES	Canonical names for the 19 Haab month names in positional order (1-19)
lords	-
modernMayanistLocale	Modern Mayanist Orthography
modernVariantLocale	Modern Variant Orthography
older16cLocale	Older 16th Century Orthography
TZOLKIN_DAY_NAMES	Canonical names for the 20 Tzolkin day names in positional order (1-20)

Functions

Function	Description
coefficientParser	-
getCalendarRound	Return a comparable instance of a Calendar Round.
getCorrelationConstant	Return a Lord of the Night by its G id.
getHaab	Return a comparable HaabMonth instantiation.
getHaabMonth	-
getI18nManager	Get the singleton I18nManager instance
getTzolkin	Return a comparable instance of a Tzolkin date.
getTzolkinDay	-
isComment	Type guard to check if a value is a Comment instance.
isNumberPrimitive	Determine if a value is a number primitive.
isPart	Type guard to ensure a value implements IPart.
isStringPrimitive	Determine if a value is a string primitive.
isWildcard	-
wrapsComment	Type guard for CommentWrapper.