Interface AnnualSunPlayerParams

interface AnnualSunPlayerParams {
    autoPlay?: boolean;
    durationSeconds?: number;
    mode?: "day" | "year";
    sunStudy: SunStudy;
}

Index

Properties

autoPlay? durationSeconds? mode? sunStudy

Properties

`Optional`autoPlay

autoPlay?: boolean

Start playing immediately. Default false.

`Optional`durationSeconds

durationSeconds?: number

Playback rate.

In "day" mode: real-time seconds per simulated day. Default 8 — sunrise to sunset in 4 real-time seconds plus a few seconds of night.
In "year" mode: real-time seconds per simulated year. Default 30 — a full Jan-to-Dec sweep in 30 seconds.

`Optional`mode

mode?: "day" | "year"

Playback mode — selects what the cursor sweeps when playing.

"day" — sweeps from 00:00 to 24:00 on the cursor's current date, looping. Useful for "day-in-the-life" shadow sweep visualisations.
"year" — sweeps from Jan 1 to Dec 31 at the cursor's current hour-of-day, looping. Useful for solstice-to-solstice shadow envelope studies.

Default "day".

sunStudy

sunStudy: SunStudy

The SunStudy this player drives.