FormIt Plugin API  v23.0.0 (2023.0.0)
FormIt.Levels Namespace Reference

Description

FormIt.Levels namespace.

Functions

json AddLevels (nHistoryID, numLevels, startElevation, deltaElevation)
 
json AutoRenameLevels (nHistoryID)
 Renames all levels with a default name according to the elevation order. More...
 
json ChangeLevelElevation (nHistoryID, levelID, newElevation)
 Change the given level's elevation. More...
 
json ChangeLevelName (levelID, levelName)
 Change the given level's name. More...
 
json CreateDefaultLevels (nHistoryID)
 Create default levels in the given History. More...
 
json DeleteLevels (nHistoryID, aLevelIDs)
 Delete the given levels in the given History. More...
 
json GetDefaultLevelHeight ()
 Returns the default level height. More...
 
json GetLevels (nHistoryID, sortByElevation)
 Returns a vector of all levels within a history. More...
 
json GetLevelsVisible ()
 Returns if levels are visible. More...
 
json GetNumLevels (nHistoryID)
 Returns the number of levels in the given history. More...
 
json GetMinLevelElevation (nHistoryID)
 Returns the elevation of the lowest level in the given history. More...
 
json GetMaxLevelElevation (nHistoryID)
 Returns the elevation of the highest level in the given history. More...
 
json GetLevelData (nHistoryID, levelID)
 GetLevelData. More...
 
json GetLevelsData (nHistoryID, sortByElevation)
 Returns a vector of LevelData for all levels within a history. More...
 
json GetLevelIDsFromSelectedObjects (nHistoryID)
 Returns the union of levels of each object and the Result (Success). More...
 
json HasLevelsInProject (checkVisibleOnly)
 Checks if there are any objects in the main history that have levels applied. More...
 
json IsExistingLevel (nHistoryID, levelName)
 Returns true if the given Level name exists. More...
 
json IsExistingLevelByElevation (nHistoryId, elevation)
 
json IsValidLevelDeltaElevation (nHistoryID, deltaElevationString, numLevels)
 Checks if the string containing the delta elevation is valid. More...
 
json IsValidLevelElevation (nHistoryID, levelId, elevationString)
 Checks if the string containing the elevation is valid for a level. More...
 
json IsValidLevelName (levelID, levelName)
 Returns true is the given level name is valid. More...
 
json IsValidNumberOfLevelsToAdd (nHistoryID, numLevelsString, deltaElevation)
 Checks if the string containing the number of levels is valid. More...
 
json SetLevelsToSelectedObjects (nHistoryID, aLevelList)
 Set the given levels to be the levels for all currently selected objects. More...
 
json SetLevelsVisible (aVisible)
 Sets levels visibility. More...
 
json SetReportAreaByLevelsOnSelection (bON)
 SetReportAreaByLevelsOnSelection. More...
 
json GetAreaForObjects (nHistoryID, aLevelId, aObjectIds)
 GetAreaForObjects. More...