Lightweight queries

Some questions do not need a whole chart. These five functions each run only as far as necessary and return; their results always agree with the corresponding fields of a full chart, because they go through the same core logic.

GetZodiacBySolarDate

Purpose Get the Chinese zodiac animal from a solar date.

Zi Wei meaning The zodiac animal is determined by the year branch, and when the year branch turns over is governed by YearDivide. For someone born between lunar New Year and the Beginning of Spring, the two settings give different animals — not a defect, a difference of school.

Signature

func GetZodiacBySolarDate(solarDate string, language Language, config *Config) (string, error)

Parameters

Return value The animal name translated into the language.

Example

zodiac, _ := iztro.GetZodiacBySolarDate("2000-8-16", iztro.LanguageEnUS, nil)
fmt.Println(zodiac)

Output

dragon

Edge cases and pitfalls

GetSignBySolarDate / GetSignByLunarDate

Purpose Get the zodiac sign.

Zi Wei meaning The zodiac sign is a Western astrology concept determined solely by the solar date, unrelated to the Zi Wei algorithm. The lunar version converts to solar first, so both give the same result for the same day.

Signature

func GetSignBySolarDate(solarDate string, language Language) (string, error)
func GetSignByLunarDate(lunarDate string, isLeapMonth bool, language Language) (string, error)

Parameters

There is no config parameter — zodiac signs are unaffected by any setting.

Return value The sign name.

Example

s1, _ := iztro.GetSignBySolarDate("2000-8-16", iztro.LanguageEnUS)
s2, _ := iztro.GetSignByLunarDate("2000-7-17", false, iztro.LanguageEnUS)

fmt.Println(s1, s2)

Output

leo leo

GetMajorStarBySolarDate / GetMajorStarByLunarDate

Purpose Get just the Soul palace's major stars, without charting the whole thing.

Zi Wei meaning The major stars of the Soul palace are the single most commonly asked item in Zi Wei Dou Shu. When the Soul palace is empty, convention borrows the major stars of the opposite palace, and this function already handles that step.

Signature

func GetMajorStarBySolarDate(
    solarDate string, timeIndex uint8, fixLeap bool, language Language, config *Config,
) (string, error)

func GetMajorStarByLunarDate(
    lunarDate string, timeIndex uint8, leap LeapMonth, language Language, config *Config,
) (string, error)

Parameters

Return value Several major stars separated by commas; the opposite palace's major stars when the Soul palace is empty.

Example

en, _ := iztro.GetMajorStarBySolarDate("2000-8-16", 2, true, iztro.LanguageEnUS, nil)
zh, _ := iztro.GetMajorStarBySolarDate("2000-8-16", 2, true, iztro.LanguageZhCN, nil)

fmt.Println(en, zh)

Output

emperor 紫微

Edge cases and pitfalls

MajorStarKeysBySolarDate / MajorStarKeysByLunarDate

Purpose The Soul palace's major stars as language-independent keys — the key form of the two functions above, for programmatic checks.

Signature

func MajorStarKeysBySolarDate(
    solarDate string, timeIndex uint8, fixLeap bool, config *Config,
) ([]string, error)

func MajorStarKeysByLunarDate(
    lunarDate string, timeIndex uint8, leap LeapMonth, config *Config,
) ([]string, error)

Return value []string — star key constant values (e.g. StarZiweiMaj); an empty Soul palace borrows its opposite's major stars just the same. Keys are language-independent, so these functions take no language.

Example

keys, _ := iztro.MajorStarKeysBySolarDate("2000-8-16", 2, true, nil)

fmt.Println(keys)

Output

[ziweiMaj]