ISunSettings

Type interfaceSince 5.21.0

Settings shared by the series that show day and night.

Sources

ISunSettings is an interface: it describes a shape of data and is not imported on its own.

Inheritance

ISunSettings does not extend any other symbol.

ISunSettings is extended by IMapRasterSeriesSettings, INightSeriesSettings.

Properties

#sunDate

Type "now" | number | string | DateSince 5.21.0

Works out sunPosition for this date: "now", a timestamp in milliseconds, a date string (e.g. "2026-12-21T12:00:00Z") or a Date.

With "now" the sun moves with the clock, once a minute. Overrides sunPosition.

To change a Date, set a new one: a change made to the same object goes unnoticed.

#sunPosition

Type IGeoPoint

The point where the sun is directly overhead. am5map.getSunPosition() finds it for a date, or set sunDate to have the series find it.

#twilight

Type undefined | numberDefault 12

How wide the twilight between day and night is, in degrees of the sun's height: day turns into night from half this above the horizon to half below it.