FormIt Plugin API  v23.0.0 (2023.0.0)
FormIt.Analysis.Solar Namespace Reference

Description

Functions

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