The FreeCAD Spreadsheet Workbench Icon
The Spreadsheet Workbench allows you to create and edit spreadsheets, use data from the spreadsheet as parameters in a model, fill the spreadsheet with data retrieved from a model, perform calculations, and export the data to other spreadsheet applications such as LibreOffice or Microsoft Excel.
The Spreadsheet Workbench has been available since FreeCAD 0.15.
A spreadsheet cell may contain arbitrary text or an expression. Technically, expressions must start with an equals '=' sign. However, the spreadsheet attempts to be intelligent; if you enter what looks like an expression without the leading '=', one will be added automatically.
Cell expressions may contain numbers, functions, references to other cells, and references to properties of the model (But see Current Limitations below). Cells are referenced by their column (CAPITAL letter) and row (number). A cell may also be referenced by its alias-name (below). Example: B4 + A6
References to objects in the model are explained under References to CAD-Data below. Using spreadsheet cell values to define model properties are explained under Spreadsheet Data in Expressions below. For more specifics on how expressions are formed, see Expressions.
Standard trigonometric and other common mathematical functions as well as statistical aggregation functions are supported (see Expressions).
Interaction between Spreadsheets and the CAD Model
Data in the cells of a spreadsheet may be used in CAD model parameter expressions. Thus, a spreadsheet may be used as the source for parameter values used throughout a model, effectively gathering the values in one place. When values are changed in the spreadsheet, they are propagated throughout the model.
Similarly, properties from CAD model objects may be used in expressions in spreadsheet cells. This allows use of object properties like volume or area in the spreadsheet. If the name of an object in the CAD model is changed, the change will automatically be propagated to any references in spreadsheet expressions using the name which was changed.
More than one spreadsheet may be used in a document; spreadsheets may be given a user-assigned name (rename) like any other object.
FreeCAD checks for cyclic dependencies. See Current Limitations.
The properties of a spreadsheet cell can be edited with a right-click on a cell. The following dialog pops up:
As indicated by the tabs, the following properties can be changed:
- Color: Text color and background color
- Alignment: Text horizontal and vertical alignment
- Style: Text style: bold, italic, underline
- Units: Display units for this cell. Please read the Units section below.
- Alias: Define an alias-name for this cell. This alias-name can be used in cell formulas and also in general FreeCAD Expressions.
While one may use the row and column number in an expression to reference a cell, best practice is to give the cell an alias-name and use that. For example, if the data in cell B1 contained the length parameter for an object, an alias name of "MyObject_Length" would allow the value to be referred to as "Spreadsheet.MyObject_Length" instead of "Spreadsheet.B1". introduced in version 0.16
References To CAD-Data
As indicated above, one can reference data from the CAD model in spreadsheet expressions.
Computed expressions in spreadsheet cells start with an equals ('=') sign. However, the spreadsheet entry mechanism attempts to be smart. An expression may be entered without the leading '='; if the string entered is a valid expression, an '=' is automatically added when the finalis typed. If the string entered is not a valid expression (often the result of entering something with the wrong case, e.g. "MyCube.length" instead of "MyCube.Length"), no leading '=' is added and it is treated as simply a text string.
Note: The above behavior (auto insert of '=') has some unpleasant ramifications:
- If you want to keep a column of names corresponding to the alias-names in an adjacent column of values, you must enter the name in the label column before giving the cell in the value column its alias-name. Otherwise, when you enter the alias-name in the label column the spreadsheet will assume it is an expression and change it to "=<alias-name>"; and the displayed text will be the value from the <alias-name> cell.
- If you make an error when entering the name in the label column and wish to correct it, you cannot simply change it to the alias-name. Instead, you must first change the alias-name to something else, then fix the text name in the label column, then change the alias-name in the value column back to its original.
One way to side-step these issues is to prefix text labels corresponding to alias-names with a fixed string, thereby making them different. Note that "_" will not work, as it is converted to "=". However, a blank, while invisible, will work.
The following table shows some examples assuming the model has a feature named "MyCube":
|CAD-Data||Cell in Spreadsheet||Result|
|Parametric Length of a Part-Workbench Cube||=MyCube.Length||Length with units mm|
|Volume of the Cube||=MyCube.Shape.Volume||Volume in mm³ without units|
|Type of the Cube-shape||=MyCube.Shape.ShapeType||String: Solid|
|Label of the Cube||=MyCube.Label||String: MyCube|
|x-coordinate of center of mass of the Cube||=MyCube.Shape.CenterOfMass.x||x-coordinate in mm without units|
Spreadsheet Data in Expressions
The usage of spreadsheet data in other parts of FreeCAD requires a fully defined name. Because it is possible to have more than one spreadsheet in a document, the spreadsheet name together with the cell name or alias is required. The following pictures show the usage of an alias "number" from a spreadsheet "MySheet" in an expression in the PartDesign Workbench.
Typing an "M" shows a list of available names (above). The arrow-keys allow one to move down to "MySheet" and select it;will cause it to be completed in the expression. You can also continue typing or click the entry with the mouse.
Typing an "n" now shows the list of available alias names in MySheet starting with "n" (above). "number" can now be selected as described above. Once a valid name with usable content is entered, the result field will show the calculated value; in this case, the length (below).
Further typing, such as adding a "+" sign, will result in an expression which is no longer valid which will be indicated. Continuing to complete the expression can again result in a valid expression.
The Spreadsheet has a notion of dimension (units) associated with cell values. A number entered without an associated unit has no dimension. The unit should be entered immediately following the number value, with no intervening space. If a number has an associated unit, that unit will be used in all calculations. For example, the multiplication of two lengths with the unit mm gives an area with the unit mm².
If a cell contains a value which represents a dimension, it should be entered with its associated unit. While in many simple cases one can get by with a dimensionless value, it is unwise to not enter the unit. If a value representing a dimension is entered without its associated unit, there are some sequences of operations which cause FreeCAD to complain of incompatible units in an expression when it appears the expression should be valid. (This may be better understood by viewing this thread in the FreeCAD forums.)
You can change the units displayed for a cell value using the properties dialog units tab (above). This does not change the value contained in the cell; it only converts the existing value for display. The value used for calculations does not change, and the results of formulas using the value do not change. For example, a cell containing the value "5.08cm" can be displayed as "2in" by changing the units tab value to "in".
A dimensionless number cannot be changed to a number with a unit by the cell properties dialog. One can put in a unit string, and that string will be displayed; but the cell still contains a dimensionless number. In order to change a dimensionless value to a value with a dimension, the value itself must be re-entered with its associated unit.
Occasionally it may be desirable to get rid of a dimension in an expression. This can be done by multiplying by 1 with a reciprocal unit.
Importing and exporting
Sheets can be imported and exported to the csv format which can also be read and written by most other spreadsheet applications such as Microsoft Excel or LibreOffice Calc. When importing files into FreeCAD, the delimiter (the character that is used to separate columns) must be the TAB character (this can be set when exporting from other applications). The import of a CSV-file is available from the menu Spreadsheet → Import Spreadsheet or by clicking on the icon . This import function does not open Excel files or any other spreadsheet format.
Spreadsheets in Excel-format "xlsx" can be imported via the menu File → Import.... Excel-spreadsheets can also be opened by clicking in the menu File → Open... or by clicking on the icon . In these cases a new document with a spreadsheet inside is created. The following features are supported:
- all functions that are also available in the FreeCAD spreadsheet. Other functions give an error in the corresponding cell after the import.
- Alias names for cells
- More than one "Sheet" in the Excel-spreadsheet. In this case one FreeCAD spreadsheet is created for each Excel sheet.
Other functionality is not imported into the FreeCAD spreadsheet. The Excel-import is introduced in version 0.17 of FreeCAD.
FreeCAD checks for cyclic dependencies. By design, that check stops at the level of the spreadsheet object. As a consequence, you should not have a spreadsheet which contains both cells whose values are used to specify parameters to the model, and cells whose values use output from the model. For example, you cannot have cells specifying the length, width, and height of an object, and another cell which references the total volume of the resulting shape. This restriction can be surmounted by having two spreadsheets: one used as a data-source for input parameters to the model and the other used for calculations based on resultant geometry-data.
When cells are copied, only the content (expression/value) is copied. The Cell Properties described above are not copied.
For earlier versions see Spreadsheet legacy.
import Spreadsheet sheet = App.ActiveDocument.addObject("Spreadsheet::Sheet") sheet.Label = "Dimensions"