Interface DaylightAnalysisPanelParams

Constructor parameters for DaylightAnalysisPanel.

interface DaylightAnalysisPanelParams {
    container?: HTMLElement;
    initialDaysPerYear?: number;
    initialGrid?: AnalysisGrid;
    initialHoursPerDay?: number;
    initialSkyModel?: SkyModel;
    initialYear?: number;
    scene: Scene;
    storageKey?: string;
    sunStudy: SunStudy;
    visible?: boolean;
}

Properties

container? initialDaysPerYear? initialGrid? initialHoursPerDay? initialSkyModel? initialYear? scene storageKey? sunStudy visible?

Properties

Optionalcontainer

container?: HTMLElement

OptionalinitialDaysPerYear

initialDaysPerYear?: number

Days sampled per year. Default 12 (monthly cadence).

OptionalinitialGrid

initialGrid?: AnalysisGrid

Optional starting grid. When omitted, the panel auto-fits to the Scene's AABB on first mount.

OptionalinitialHoursPerDay

initialHoursPerDay?: number

Hours sampled per day. Default 24 (hourly cadence).

OptionalinitialSkyModel

initialSkyModel?: SkyModel

Initial sky-luminance model. Default "none" (direct-sun only).

OptionalinitialYear

initialYear?: number

Year to evaluate. Default new Date().getUTCFullYear().

scene

scene: Scene

Scene that the analysis raycasts against for occlusion.

OptionalstorageKey

storageKey?: string

sunStudy

sunStudy: SunStudy

SunStudy whose latitude / longitude / northAngleDegrees feed every analysis run from this panel.

Optionalvisible

visible?: boolean

Settings

Member Visibility

On This Page

Properties