FormIt Plugin API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt.Analysis.Solar Namespace Reference

Description

Functions

json EnterAnalysisMode ()
 Start Solar Analysis mode.
 
json ToggleAnalysisMode ()
 ToggleAnalysisMode Solar Analysis mode.
 
json ExitAnalysisMode ()
 End Solar Analysis mode.
 
json ToggleFaceSelections (aFacePaths)
 Toggle the face selection with the given faces.
 
json ResetAnalysis ()
 Reset the analysis.
 
json SetMethod (bMonthlyPeak)
 Sets the analysis method to monthly peak or yearly cumulative.
 
json SetPeakMonth (month)
 Sets the month for the monthly peak analysis method.
 
json GetPeakMonth ()
 Gets the month for the monthly peak analysis method.
 
json GetMethod ()
 Gets the analysis method : monthly peak (true) or yearly cumulative (false).
 
json GetLimits ()
 GetLimits Parameters: In: Out: {success: ,min: , max:}
 
json GetUnitString ()
 GetUnitString Parameters: In: Out: {success: , UnitString:}
 
json IsInSolarAnalysisMode ()
 IsInSolarAnalysisMode Parameters: In: Out: bool IsInSolarAnalysisMode
 
json IsNewAnalysisEnabled ()
 IsNewAnalysisEnabled Parameters: In: Out: bool
 
json IsAnalysisInProgress ()
 IsAnalysisInProgress Parameters: In: Out: bool
 
json CanAnalyze ()
 CanAnalyze Parameters: In: Out: bool
 
json GetWeatherDataStatus ()
 GetWeatherDataStatus Parameters: In: Out: status of weather data
 
json SetWeatherDataStatus (status)
 SetWeatherDataStatus Parameters: In: status of weather data Out:
 
json GetNumTooltipsToShow ()
 GetNumTooltipsToShow Parameters: In: Out: Number of tooltips to show
 
json SetNumTooltipsToShow (numToolTips)
 SetNumTooltipsToShow Parameters: In: Out: JSON_UNDEFINED
 
json Analyze ()
 
json CancelAnalysis ()
 Cancel the analysis.
 
json GetValueFromFaceAtPoint (face, pt)
 Gets the analysis value for a point on a face.