Worksheet functions take an argument, perform an action, and return a value or values. There are two basic types of functions: those that use the values you enter, and those that use information from objects in the drawing. The arguments required by the two function types are different.
● Number or text arguments: Functions that begin with a lower case letter typically require a number value or a cell address as the argument. For example, the acos function returns the arccosine of the value that is specified in the function argument. The argument you enter can be a mathematical expression (such as 3/5), an address of a cell that contains a number (such as A12), or an actual number. The argument for all trigonometry functions must be in radians.
● Criteria arguments: Functions that begin with a capital letter must be applied to one or more specific objects in the drawing. In a cell in a database header row, a function is automatically applied to the object listed in each sub-row, so no criteria argument is required.
However, in a spreadsheet cell, you must enter criteria to select the objects the function applies to. For example, the Area function returns the combined area of all 2D objects that meet the criteria. To specify which objects to obtain the area of, either use the Insert > Criteria command on the Worksheet menu, or enter the criteria manually. For details about how to specify criteria such as the object type, class, or visibility, see the developer-oriented documentation here (internet access required):
developer.vectorworks.net/index.php/VS:Search_Criteria#Search_Criteria_Tables
developer.vectorworks.net/index.php/VS:Function_Reference_Appendix#attrCrit
Use the Formula syntax rules when entering worksheet functions.
In the following list of worksheet functions, the type of argument the function takes is shown in parentheses.
The arccosine of a number. The arccosine is the angle whose cosine is number. The returned angle is given in radians in the range 0 to pi. Number is the cosine of the angle, and must be from -1 to 1. Related function: cos
Example: =acos(3/5) returns the angle for which the cosine value is 3/5
The angle (measured from horizontal) of the objects that meet the specified criteria, in degrees. Use this function to return the angles of lines and walls (measured from horizontal), the span angles of arcs, and the slope angles of slabs.
Examples:
● Database header cell: =Angle returns the angle of each object in the database
● Spreadsheet cell: =Angle((t=arc)&(n='arc-1')) returns the sweep angle of the arc object named “arc-1” in the drawing
The total area of 2D objects that meet the specified criteria, based on the Area units in the Units dialog box. Related function: Perim
Examples:
● Database header cell: =Area returns the area of each object in the database
● Spreadsheet cell: =Area(t=rect) returns the combined area of all rectangle objects in the drawing
The arcsine of a number. The arcsine is the angle whose sine is number. The returned angle is given in radians in the range -pi/2 to pi/2. To express the arcsine in degrees, use the rad2deg function (or multiply the result by 180/pi). Number is the sine of the angle and must be from -1 to 1. Related function: sin
Example: =asin(A3) returns the angle for which the sine value is given in cell A3
The bottom 2D boundary (minimum y coordinate) of the objects that meet the specified criteria. Related functions: LeftBound, RightBound, TopBound
Examples:
● Database header cell: =BotBound returns the bottom 2D boundary of each object in the database
● Spreadsheet cell: =BotBound(t=locus) returns the bottom 2D boundary of the locus that has the lowest bottom 2D boundary value in the drawing
The class name of objects that meet the specified criteria.
Examples:
● Database header cell: =Class returns the class of each object in the database
● Spreadsheet cell: =Class(sel=true) returns the class name of the selected objects in the drawing
The area (minus any holes) of one side of the components that meet the specified criteria and are in the specified class. Related functions: CompAreaByName, ComponentArea
Examples:
● Database header cell: =CompAreaByClass('Class-1') returns the area of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompAreaByClass(t=wall,'Class-1') returns the combined area of the components assigned to the class “Class-1” for all walls in the drawing
The area (minus any holes) of one side of the components that meet the specified criteria and have the specified name. Related functions: CompAreaByClass, ComponentArea
Examples:
● Database header cell: =CompAreaByName('Brick Veneer') returns the area of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompAreaByName(t=wall,'Brick Veneer') returns the combined area of the components with the name “Brick Veneer” for all walls in the drawing
The name of the components that meet the specified criteria and have the specified name. Related function: CompNameByClass
Examples:
● Database header cell: =CompClassByName('Brick Veneer') returns the class of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompClassByName(t=wall,'Brick Veneer') returns the class of the first component with the name “Brick Veneer” for all walls in the drawing
The Lambda value of the components that meet the specified criteria and are in the specified class. Related functions: CompLambdaByName, ComponentLambda
Examples:
● Database header cell: =CompLambdaByClass('Class-1') returns the Lambda value of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompLambdaByClass(t=wall,'Class-1') returns the Lambda value of the first component assigned to the class “Class-1” for all walls in the drawing
The Lambda value of the components that meet the specified criteria and have the specified name. Related functions: CompLambdaByClass, ComponentLambda
Examples:
● Database header cell: =CompLambdaByName('Brick Veneer') returns the Lambda value of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompLambdaByName(t=wall,'Brick Veneer') returns the Lambda value of the first component with the name “Brick Veneer” for all walls in the drawing
The name of the components that meet the specified criteria and are in the specified class. Related function: CompClassByName
Examples:
● Database header cell: =CompNameByClass('Class-1') returns the name of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompNameByClass(t=wall,'Class-1') returns the name of the first component assigned to the class “Class-1” for all walls in the drawing
The area (minus any holes) of one side of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related function: CompAreaByClass, CompAreaByName
Examples:
● Database header cell: =ComponentArea(2) returns the area of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentArea(t=wall,1) returns the combined area of the first components for all walls in the drawing
The Lambda value of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related functions: CompLambdaByClass, CompLambdaByName
Examples:
● Database header cell: =ComponentLambda(2) returns the Lambda value of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentLambda(t=wall,1) returns the Lambda value of the first component for all walls in the drawing
The name of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related function: CompNameByClass
Examples:
● Database header cell: =ComponentName(2) returns the name of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentName(t=wall,1) returns the name of the first component for all walls in the drawing
The R-value of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related functions: CompRValueByClass, CompRValueByName
Examples:
● Database header cell: =ComponentRValue(2) returns the R-value of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentRValue(t=wall,1) returns the combined R-values of the first components for all walls in the drawing
The thickness of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related functions: CompThicknessByClass, CompThicknessByName
Examples:
● Database header cell: =ComponentThickness(2) returns the thickness of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentThickness(t=wall,1) returns the combined thickness of the first components for all walls in the drawing
The U-value of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related functions: CompUValueByClass, CompUValueByName
Examples:
● Database header cell: =ComponentUValue(2) returns the U-value of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentUValue(t=wall,1) returns the combined U-values of the first components for all walls in the drawing
The volume (minus any holes) of the components that meet the specified criteria and have the specified index. Index is the 1-based index identifying the component. Related functions: CompVolumeByClass, CompVolumeByName
Examples:
● Database header cell: =ComponentVolume(2) returns the volume of the second component for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =ComponentVolume(t=wall,1) returns the combined volume of the first components for all walls in the drawing
The R-value of the components that meet the specified criteria and are in the specified class. Related functions: CompRValueByClass, ComponentRValue
Examples:
● Database header cell: =CompRValueByClass('Class-1') returns the R-value of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompRValueByClass(t=wall,'Class-1') returns the combined R-values of the components assigned to the class “Class-1” for all walls in the drawing
The R-value of the components that meet the specified criteria and have the specified name. Related functions: CompRValueByClass, ComponentRValue
Examples:
● Database header cell: =CompRValueByName(t=wall,'Brick Veneer') returns the R-value of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompRValueByName(t=wall,'Brick Veneer') returns the combined R-values of the components with the name “Brick Veneer” for all walls in the drawing
The thickness of the components that meet the specified criteria and are in the specified class. Related functions: CompThicknessByName, ComponentThickness
Examples:
● Database header cell: =CompThicknessByClass('Class-1') returns the thickness of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompThicknessByClass(t=wall,'Class-1') returns the combined thickness of the components assigned to the class “Class-1” for all walls in the drawing
The thickness of the components that meet the specified criteria and have the specified name. Related functions: CompThicknessByClass, ComponentThickness
Examples:
● Database header cell: =CompThicknessByName('Brick Veneer') returns the thickness of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompThicknessByName(t=wall,'Brick Veneer') returns the combined thickness of the components with the name “Brick Veneer” for all walls in the drawing
The U-value of the components that meet the specified criteria and are in the specified class. Related functions: CompUValueByName, ComponentUValue
Examples:
● Database header cell: =CompUValueByClass('Class-1') returns the U-value of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompUValueByClass(t=wall,'Class-1') returns the combined U-values of the components assigned to the class “Class-1” for all walls in the drawing
The U-value of the components that meet the specified criteria and have the specified name. Related functions: CompUValueByClass, ComponentUValue
Examples:
● Database header cell: =CompUValueByName('Brick Veneer') returns the U-value of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompUValueByName(t=wall,'Brick Veneer' returns the combined U-values of the components with the name “Brick Veneer” for all walls in the drawing
The volume of the components that meet the specified criteria and are in the specified class. Related functions: CompVolumeByName, ComponentVolume
Examples:
● Database header cell: =CompVolumeByClass('Class-1') returns the volume of the components assigned to the class “Class-1” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompVolumeByClass(t=wall,'Class-1') returns the combined volume of the components assigned to the class “Class-1” for all walls in the drawing
The volume of the components that meet the specified criteria and have the specified name. Related functions: CompVolumeByClass, ComponentVolume
Examples:
● Database header cell: =CompVolumeByName('Brick Veneer') returns the volume of the components with the name “Brick Veneer” for each wall, round wall, roof, roof face, and slab object in the database
● Spreadsheet cell: =CompVolumeByName(t=wall,'Brick Veneer') returns the combined volume of the components with the name “Brick Veneer” for all walls in the drawing
Joins several text strings into one text string.
Example: =concat(B3,', ',B4) returns the contents of cells B3 and B4 as a single string, separated by a comma and a space
The cosine of a given angle. Number is the angle in radians for which the cosine is calculated. Related function: acos
Example: =cos(deg2rad(23)) converts a 23-degree angle to its radian equivalent, and returns the cosine of the angle
The number of objects that meet the specified criteria.
Examples:
● Database header cell: =Count returns the total number of objects for each row in the database
● Spreadsheet cell: =Count(s='simple sofa') returns the total number of symbol objects named “simple sofa” in the drawing
When used with the COUNT function, the SEL (selection status) criterion counts objects that are actually non-selectable, such as the individual items within a group. The VSEL (visible selection status) criterion counts only the visibly selected items, which is the same counting method used for the Object Info palette. For example, if you select and count a group that has 11 items in it, the SEL criterion returns a value of 12 (the group, plus the 11 items). The VSEL criterion returns a value of 1 (the group only).
The combined length of the curtain wall frames that meet the specified criteria and are in the specified class. To find all frames in a curtain wall, use an empty class name. Related functions: CurtWallPnlAreaNet, CurtWallPnlAreaGross
Examples:
● Database header cell: =CurtWallFrameLength('') returns the combined length of the curtain wall frames for each curtain wall in the database
● Spreadsheet cell: =CurtWallFrameLength(t=wall, '') returns the combined length of the curtain wall frames for all curtain walls in the drawing
The combined gross area of the curtain wall panels in the walls that meet the specified criteria and are in the specified class. The gross area includes portions of the panel covered by frames. To find all panels in a curtain wall, use an empty class name. Related functions: CurtWallFrameLength, CurtWallPnlAreaNet
Examples:
● Database header cell: =CurtWallPnlAreaGross('') returns the combined gross area of the curtain wall panels for each curtain wall in the database
● Spreadsheet cell: =CurtWallPnlAreaGross(t=wall, '') returns the combined gross area of the curtain wall panels for all curtain walls in the drawing
The net area of the curtain wall panels in the walls that meet the specified criteria and are in the specified class. The net area includes only the visible area bounded by frames. To find all panels in a curtain wall, use an empty class name. Related functions: CurtWallFrameLength, CurtWallPnlAreaGross
Examples:
● Database header cell: =CurtWallPnlAreaNet ('Class-1') returns the combined net area of the curtain wall panels assigned to the class “Class-1” for each curtain wall in the database
● Spreadsheet cell: =CurtWallPnlAreaNet(t=wall, 'Class-1') returns the combined net area of the curtain wall panels assigned to the class “Class-1” for all curtain walls in the drawing
Uses a script to determine the contents of a database row and its sub-rows. Runs the specified VectorScript or Python script, passing the parameters that follow the script name to the script, and expecting it to return a list of objects which will be used as sub-rows in the order they are received from the script. An optional parameter before the script name specifies the script’s folder path within the Vectorworks installation. For a list of folder path values, see the developer-oriented documentation here (internet access required):
developer.vectorworks.net/index.php/VS:GetFolderPath
See Running scripts from worksheets for details.
Related function: RunScript
Examples:
● Database header cell: =DataBaseByScript('My Script') executes the VectorScript script named “My Script” and returns a value for each object in the database, sending them to database sub-rows
● Spreadsheet cell: =DataBaseByScript('ScriptFile.py', 2, 1) Turns the row into a database row, executes the Python script “ScriptFile.py” in the Vectorworks Plug-Ins folder, passing the parameters “2” and “1,” and returns a value for each object in the database, sending them to database sub-rows.
The value of a dynamic text field for all data tag objects that meet the specified criteria and have a dynamic text field with the specified label in the layout.
Examples:
● Database header cell: =DataTagField('Color'), where “Color” is the label of a user-entered text field in a data tag, returns the value for the “Color” field (for example, “Red”) for each data tag in the database.
● Spreadsheet cell: =DataTagField(sel=true, 'Color'), where “Color” is the label of a user-entered text field in a data tag, returns the value for the “Color” field (for example, “Red”) for the selected data tag in the drawing.
Converts a number from degrees to radians. Number is the value in degrees to be converted to radians.
Example: =deg2rad(47) converts the 47-degree angle measurement to its radian equivalent
e raised to the power of number. The constant e equals 2.71828182845904, the base of the natural logarithm. Number is the exponent applied to the base e.
Example: =exp(2) returns the numeric value of e raised to the power of 2
(Vectorworks Design Series required) The value of a COBie property for an object. The criteria is a string with two elements separated by a period. The first element is the name of the COBie worksheet and the second element is the name of the column in that worksheet.
Example: =GETCOBIEPROPERTY ('space.floorname') returns the FloorName value for objects whose COBie property is Space
(Vectorworks Design Series required) The data source of the selected worksheet and column of an object. The criteria is a string with two elements separated by a period. The first element is the name of the COBie worksheet and the second element is the name of the column in that worksheet.
Example: =GETCOBIESOURCE ('space.floorname') returns the FloorName data source for objects whose COBie property is Space
(Vectorworks Design Series required) The value of a specific IFC property associated with an IFC object. The criteria is a string with two elements separated by a period. The first element is either an IFC entity or PSet name, and the second element is the name of the IFC property.
Example: =GETIFCPROPERTY ('ifcfurnishingelement.name') returns the Name value for IFC objects whose IFC entity is IfcFurnishingElement
(Vectorworks Architect required) The name of the space that surrounds the object that meets the specified criteria. Related function: GetSpaceNumForObj
Examples:
● Database header cell: =GetSpaceNameForObj returns the space name for each object in the database
● Spreadsheet cell: =GetSpaceNameForObj(n='chair-1') returns the space name for the object named “chair-1”
(Vectorworks Architect required) The number of the space that surrounds the object that meets the specified criteria. Related function: GetSpaceNameForObj
Examples:
● Database header cell: =GetSpaceNumForObj returns the space number for each object in the database
● Spreadsheet cell: =GetSpaceNumForObj(n='chair-1') returns the space number for the object named “chair-1”
The gradient fill of objects that meet the specified criteria.
Examples:
● Database header cell: =GradientFill returns the gradient fill for each object in the database
● Spreadsheet cell: =GradientFill(sel=true) returns the gradient fill of the selected objects in the drawing
The hatch fill of objects that meet the specified criteria.
Examples:
● Database header cell: =HatchFill returns the hatch fill for each object in the database
● Spreadsheet cell: =HatchFill(sel=true) returns the hatch fill of the selected objects in the drawing
The combined delta y (height) of objects that meet the specified criteria. Related function: Width
Examples:
● Database header cell: =Height returns the height (delta y) for each object in the database
● Spreadsheet cell: =Height(sel=true) returns the combined height (delta y) value of the selected objects in the drawing
Use value_if_true if logical_test is true, value_if_false if logical_test is false.
Use this function to conduct conditional tests on values and formulas and to branch based on the results of that test. The outcome of the test determines the value returned by the If function. The logical_test can be any value or expression that can be evaluated to true or false. Up to seven If statements can be nested as value_if_true, value_if_false arguments. Boolean statements within an if statement must be in parentheses. Text within an if statement should be enclosed within quotation marks.
Examples:
● =if(('Existing Tree'.'Condition'='Not Set'), '-', 'Existing Tree'.'Condition') If no condition value was set for the existing tree object, the value in this cell is a dash; otherwise, the value in this cell is the condition value that was set for the tree object.
● =if(('Existing Tree'.'Condition'='Not Set'); '-'; 'Existing Tree'.'Condition')
(Vectorworks Design Series required) The image associated with the object that meets the specified criteria. In the cell format, specify whether to show a thumbnail of the object, or the 2D attributes applied to the object.
Examples:
● Database header cell: =Image returns the image for each object in the database
● Spreadsheet cell: =Image(s='cabinet') returns the image of the symbol named “Cabinet”
The image fill of objects that meet the specified criteria.
Examples:
● Database header cell: =ImageFill returns the image fill for each object in the database
● Spreadsheet cell: =ImageFill(sel=true) returns the image fill of the selected objects in the drawing
Removes any fractional part of a number. Number is the real number to be changed to an integer. Related function: round
Example: =int(B9) returns the value in cell B9 without its fractional component
The flipped state of the objects that meet the specified criteria.
Examples:
● Database header cell: =IsFlipped returns the flip state for each object in the database
● Spreadsheet cell: =IsFlipped(PON=window) returns the total number of window objects in the drawing that are flipped
The layer name of objects that meet the specified criteria.
Examples:
● Database header cell: =Layer returns the layer of each object in the database
● Spreadsheet cell: =Layer(sel=true) returns the layer name of the selected objects in the drawing
The left side 2D boundary (minimum x coordinate) of the objects that meet the specified criteria. Related functions: BotBound, TopBound, RightBound
Examples:
● Database header cell: =LeftBound returns the left 2D boundary for each object in the database
● Spreadsheet cell: =LeftBound(t=locus) returns the left 2D boundary of the leftmost locus in the drawing
The length of lines, walls, or path-based objects that meet the specified criteria.
Examples:
● Database header cell: =Length returns the length for each object in the database
● Spreadsheet cell: =Length(t=line) returns the total length of all line objects in the drawing
The line type of objects that meet the specified criteria.
Examples:
● Database header cell: =LineType returns the line type for each object in the database
● Spreadsheet cell: =LineType(sel=true) returns the line type of the selected objects in the drawing
The natural logarithm (base e). Number is the positive real number for which the logarithm is calculated. Related function: exp
Example: =ln(12) returns the natural logarithm of 12
The base 10 logarithm. Number is the positive real number for which the logarithm is calculated. Related function: ln
Example: =ln(12) returns the natural logarithm of 12
The largest number in the list of arguments. Number is 1–14 numbers for which the maximum value is to be found. Related function: min
Example: =max(C5,C7,C9) returns the largest of the numbers that are in cells C5, C7, and C9
The smallest number in the list of arguments. Number is 1–14 numbers for which the minimum value is to be found. Related function: max
Example: =min(C5,C7,C9) returns the smallest of the numbers that are in cells C5, C7, and C9
The name of objects that meet the specified criteria.
Examples:
● Database header cell: =Name returns the name for each object in the database
● Spreadsheet cell: =Name(sel=true) returns the name of the selected objects in the drawing
The texture of objects that meet the specified criteria.
Examples:
● Database header cell: =ObjectTexture returns the texture of each object in the database
● Spreadsheet cell: =ObjectTexture(sel=true) returns the texture of the selected objects in the drawing
The numeric object type ID of objects that meet the specified criteria. For a list of object type IDs, see the developer-oriented documentation here (internet access required):
developer.vectorworks.net/index.php/VS:Function_Reference_Appendix#objects
Examples:
● Database header cell: =ObjectType returns the object type value for each object in the database
● Spreadsheet cell: =ObjectType(sel=true) returns the object type value of the selected object; for example, the object type value for a light is 81
The type name of objects that meet the specified criteria.
Examples:
● Database header cell: =ObjectTypeName returns the type name for each object in the database
● Spreadsheet cell: =ObjectTypeName(sel=true) returns the type name of the selected objects in the drawing
(Vectorworks Architect required) The Energos status (1 if it is included in calculations, 0 if it is not) of the objects that meet the specified criteria.
Examples:
● Database header cell: =ObjIncludeInEnergos returns the Energos status for each wall, round wall, roof, roof face, slab, door, and window object in the database
● Spreadsheet cell: =ObjIncludeInEnergos(t=wall) returns the Energos status for all walls in the drawing
(Vectorworks Architect required) The R-value of objects that meet the specified criteria. Related function: ObjUValue
Examples:
● Database header cell: =ObjectRValue returns the R-value for each wall, round wall, roof, roof face, slab, door, and window object in the database
● Spreadsheet cell: =ObjectRValue(n='wall-1') returns the R-value for the wall named “wall-1”
(Vectorworks Architect required) The U-value of objects that meet the specified criteria. Related function: ObjRValue
Examples:
● Database header cell: =ObjectUValue returns the U-value for each wall, round wall, roof, roof face, slab, door, and window object in the database
● Spreadsheet cell: =ObjectUValue(n='wall-1') returns the U-value for the wall named “wall-1”
The combined perimeter of objects that meet the specified criteria.
Examples:
● Database header cell: =Perim returns the perimeter for each object in the database
● Spreadsheet cell: =Perim(sel=true) returns the total perimeter of all selected objects
(Vectorworks Landmark required) The specific plant image from the plant style’s plant data pane. Indicate 1, 2, 3, or 4 to set the image from the Image Plant Form, Image Detail, Image Misc, or Custom Image, respectively. In the cell format, specify the plant by criteria (by selecting the plant with criteria such as, Field value = Plant ID = xx).
Examples:
● Database header cell: =PlantImage(2) displays the image specified for Image Detail in the Plant Data pane of the plant symbol definition
● Spreadsheet cell: =PlantImage((‘Plant’.’plant ID’=’TaxfR’), 4) displays the image specified for Custom Image in the Plant Data pane of the plant symbol definition with a plant ID of TaxfR
Converts a number from radians to degrees. Number is the value in radians to be converted to degrees.
Example: =rad2deg(0.5235987) converts the radian angle measurement to its degree equivalent
The right side 2D boundary (maximum x coordinate) of the objects that meet the specified criteria. Related functions: BotBound, TopBound, LeftBound
Examples:
● Database header cell: =RightBound returns the right 2D boundary for each object in the database
● Spreadsheet cell: =RightBound(t=rect) returns the right 2D boundary of the rightmost rectangle in the drawing
The heated area of the roof (minus the eave overhang) along the slope, combined for all objects that meet the specified criteria. Related function: RoofArea_HeatedProj
Examples:
● Database header cell: =RoofArea_Heated returns the heated area for each roof and roof face object in the database
● Spreadsheet cell: =RoofArea_Heated (st=roofface) returns the combined heated area of all roof face objects in the drawing
The heated area of the roof (minus the eave overhang) projected to the layer plane, combined for all objects that meet the specified criteria. Related function: RoofArea_Heated
Examples:
● Database header cell: =RoofArea_HeatedProj returns the heated area for each roof and roof face object in the database, as projected to the layer plane
● Spreadsheet cell: =RoofArea_HeatedProj (t=roof) returns the combined heated area of all roof objects in the drawing, as projected to the layer plane
The total area of the roof along the slope. Related function: RoofArea_TotalProj
Examples:
● Database header cell: =RoofArea_Total returns the total area for each roof and roof face object in the database
● Spreadsheet cell: =RoofArea_Total(st=roofface) returns the combined total area of all roof face objects in the drawing
The total area of the roof, projected to the layer plane. Related function: RoofArea_Total
Examples:
● Database header cell: =RoofArea_TotalProj returns the total area for each roof and roof face object in the database, as projected to the layer plane
● Spreadsheet cell: =RoofArea_Totalproj(t=roof) returns the combined total area of all roof objects in the drawing, as projected to the layer plane
(Vectorworks Design Series required) The name of the roof style.
Examples:
● Database header cell: =RoofStyleName returns the roof style name for each roof object in the database
● Spreadsheet cell: =RoofStyleName(n='roof-1') returns the roof style name for the object named “roof-1”
Rounds the specified number to the nearest whole number. Related function: int
Example: =round(2.345) returns 2
Rounds the specified number down to the specified number of decimal digits. Related functions: round, roundup
Example: =rounddown(2.345, 2) returns 2.34
Rounds the specified number up to the specified number of decimal digits. Related functions: round, rounddown
Example: =roundup(2.345, 2) returns 2.35
Runs the specified VectorScript or Python script, passing the parameters that follow the script name to the script. An optional parameter before the script name specifies the script’s folder path within the Vectorworks installation. For a list of folder path values, see the developer-oriented documentation here (internet access required):
developer.vectorworks.net/index.php/VS:GetFolderPath
See Running scripts from worksheets for details.
Related function: DataBaseByScript
Examples:
● Database header cell: =RunScript('My Script') executes the VectorScript script named “My Script” and returns a value for each object in the database
● Spreadsheet cell: =RunScript(2, 'ScriptFile.py', 2, 1) executes the Python script “ScriptFile.py” in the Vectorworks Plug-Ins folder, passing the parameters “2” and “1,” and returns a value
The sine of a given angle. Number is the angle in radians for which the sine is calculated. Related function: asin
Example: =sin(deg2rad(32)) converts a 32-degree angle to its radian equivalent, and returns the sine of the angle
The sketch style of objects that meet the specified criteria.
Examples:
● Database header cell: =SketchStyle returns the sketch style for each object in the database
● Spreadsheet cell: =SketchStyle(sel=true) returns the sketch style of the selected objects in the drawing
(Vectorworks Design Series required) The name of the slab style.
Example:
● Database header cell: =SlabStyleName returns the name of the slab style for each slab object in the database
● Spreadsheet cell: =SlabStyleName(n='slab-1') returns the name of the slab style for the object named “slab-1”
(Vectorworks Design Series required) The combined thickness of slab objects (floors and roof faces) that meet the specified criteria.
Examples:
● Database header cell: =SlabThickness returns the thickness for each object in the database
● Spreadsheet cell: =SlabThickness(PON=slab) returns the combined thickness of all slab objects in the drawing
A positive square root. Number is the number for which the square root is calculated.
Example: =sqrt(D27) returns the square root of the number in cell D27
The story name of objects that meet the specified criteria.
Examples:
● Database header cell: =Story returns the story name for each object in the database
● Spreadsheet cell: =Story(sel=true) returns the story name of the selected objects in the drawing
Splits a single string into an array of strings using a delimiter, and outputs each string at the specified index.
Example: =SUBSTRING('kitchen;bedroom;bathroom;basement', ';', 2) returns “bedroom,” which is the second substring in the specified string
The sum of all numbers in the list of arguments. Number is 1–14 numbers for which the sum is calculated. Related function: Average
Example: =sum(A2,A10..A12) returns the sum of the numbers contained in cells A2, A10, A11, and A12
The total surface area of all objects that meet the criteria, based on the Area units in the Units dialog box.
Examples:
● Database header cell: =SurfaceArea returns the surface area for each object in the database
● Spreadsheet cell: =SurfaceArea(st=sphere) returns the total surface area of all sphere objects in the drawing
The symbol name of the symbol instances that meet the specified criteria.
Examples:
● Database header cell: =SymbolName returns the name for each symbol instance in the database
● Spreadsheet cell: =SymbolName(sel=true) returns the symbol name of the selected symbol instances in the drawing
The tangent of the given angle. Number is the angle in radians for which the tangent is calculated. Related function: atan
Example: =tan(deg2rad(32)) converts a 32-degree angle to its radian equivalent, and returns the tangent of the angle
The top 2D boundary (maximum y coordinate) of the objects that meet the specified criteria. Related functions: BotBound, LeftBound, RightBound
Examples:
● Database header cell: =TopBound returns the top 2D boundary for each object in the database
● Spreadsheet cell: =TopBound(sel=true) returns the top 2D boundary of the topmost selected object
Converts a text string that represents a number to a number.
Example: =value('2e3') returns the numeric value of 2 times 10 raised to the power of 3
The total volume of all objects that meet the criteria, based on the Volume units in the Units dialog box.
Examples:
● Database header cell: =Volume returns the volume for each object in the database
● Spreadsheet cell: =Volume(t=xtrd) returns the total volume of all extrude objects in the drawing
The average of the 2D gross surface area of the interior and exterior face of one wall (ignoring holes in the wall), for walls that meet the specified criteria. Related functions: WallArea_Net, ComponentArea, CompAreaByClass, CompAreaByName
Examples:
● Database header cell: =WallArea_Gross returns the average of the gross area of the interior and exterior face of the wall, for each wall in the database; the gross area ignores holes in the wall
● Spreadsheet cell: =WallArea_Gross(t=wall) returns the average of the gross area of the interior and exterior face of the wall, combined for all walls in the drawing; the gross area ignores holes in the wall
The average of the 2D net surface area of the interior and exterior face of one wall (adjusted for holes in the wall), for walls that meet the specified criteria. Related functions: WallArea_Gross, ComponentArea, CompAreaByClass, CompAreaByName
Examples:
● Database header cell: =WallArea_Net returns the average of the net area of the interior and exterior face of the wall, for each wall in the database; the net area is adjusted for holes in the wall
● Spreadsheet cell: =WallArea_Net(t=wall) returns the average of the net area of the interior and exterior face of the wall, combined for all walls in the drawing; the net area is adjusted for holes in the wall
The average height of a wall, including wall peaks and different starting and ending heights.
Examples:
● Database header cell: =WallAverageHeight returns the average height for each wall object in the database
● Spreadsheet cell: =WallAverageHeight((t=wall)&(sel=true)) returns the average height of all walls that are selected in the drawing
(Vectorworks Design Series required) The name of the wall style.
Example:
● Database header cell: =WallStyleName returns the name of the wall style for each wall object in the database
● Spreadsheet cell: =WallStyleName(n='wall-1') returns the name of the wall style for the object named “wall-1”
The combined thickness of wall objects that meet the specified criteria.
Examples:
● Database header cell: =WallThickness returns the thickness for each wall object in the database
● Spreadsheet cell: =WallThickness(t=wall) returns the combined thickness of all walls in the drawing
The combined delta x (width) of objects that meet the specified criteria. Related function: Height
Examples:
● Database header cell: =Width returns the width (delta x) for each object in the database
● Spreadsheet cell: =Width(sel=true) returns the combined width (delta x value) of the selected object
The x coordinate of the center point of an object that meets the specified criteria. Related functions: YCenter, ZCenter, XCoordinate
Examples:
● Database header cell: =XCenter returns the x coordinate value of the center of the 2D boundary for each object in the database
● Spreadsheet cell: =XCenter(sel=true) returns the x coordinate value of the center of the 2D boundary of the selected object
The x coordinate of the insertion point for symbols, point plug-in objects, and loci. The returned value is relative to the user origin. Related functions: YCoordinate, ZCoordinate, XCenter
Example:
● Database header cell: =XCoordinate returns the x coordinate value for each object in the database
The y coordinate of the center point of an object that meets the specified criteria. Related functions: XCenter, ZCenter, YCoordinate
Examples:
● Database header cell: =YCenter returns the y coordinate value of the center of the 2D boundary for each object in the database
● Spreadsheet cell: =YCenter(sel=true) returns the y coordinate value of the center of the 2D boundary of the selected object
The y coordinate of the insertion point for symbols, point plug-in objects, and loci. The returned value is relative to the user origin. Related functions: XCoordinate, ZCoordinate, YCenter
Example:
● Database header cell: =YCoordinate returns the y coordinate value for each object in the database
The z coordinate of the center point of an object that meets the specified criteria. Related functions: XCenter, YCenter, ZCoordinate
Examples:
● Database header cell: =ZCenter returns the z coordinate value of the center of the 2D boundary for each object in the database
● Spreadsheet cell: =ZCenter(sel=true) returns the z coordinate value of the center of the 2D boundary of the selected object
The z coordinate of the insertion point for symbols, point plug-in objects, and loci. The returned value is relative to the user origin. Related functions: XCoordinate, YCoordinate, ZCenter
Example:
● Database header cell: =ZCoordinate returns the z coordinate value for each object in the database