Class AnnualSunPlayer

Index

Constructors

Properties

durationSeconds onModeChanged onPause onPlay sunStudy

Accessors

Methods

destroy pause play

Constructors

constructor

new AnnualSunPlayer(params: AnnualSunPlayerParams): AnnualSunPlayer
Parameters
- params: AnnualSunPlayerParams
Returns AnnualSunPlayer
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:51

Properties

durationSeconds

durationSeconds: number

Real-time seconds per full sweep of the active mode.

`Readonly`onModeChanged

onModeChanged: EventEmitter<AnnualSunPlayer, "day" | "year">

`Readonly`onPause

onPause: EventEmitter<AnnualSunPlayer, null>

`Readonly`onPlay

onPlay: EventEmitter<AnnualSunPlayer, null>

`Readonly`sunStudy

sunStudy: SunStudy

Accessors

mode

get mode(): "day" | "year"
Returns "day" | "year"
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:78
set mode(m: "day" | "year"): void
Parameters
- m: "day" | "year"
Returns void
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:81

playing

get playing(): boolean
Returns boolean
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:79

Methods

destroy

destroy(): void
Returns void
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:113

pause

pause(): void
Returns void
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:107

play

play(): void
Returns void
- Defined in packages/sdk/src/presentations/sunStudy/AnnualSunPlayer.ts:100