Parameter Settings

Learn how to configure parameter behavior in CalcTree, including visibility, default values, and input/output roles.

Access parameter settings by right clicking on the parameter on the page, and clicking 'settings.

This will open up the parameter settings pane on the right hand side of the screen, looking something like this:

Parameter settings panel

This is where you can control the parameters display name, name, formula, view, format and rounding, visibility and see it's dependancies.

Display Name

The display name is how the parameter is visually presented on the page. You can enter it using either LaTeX syntax or plain text—typing a space at the beginning will force plain text.

CalcTree uses KaTeX to render LaTeX math notation.

This display name also appears in dependent formulas, allowing equations to be shown using functional math notation.

Name

This is the internal name of the parameter used for referencing it in formulas, linking between sources, and via API. It is automatically generated from the display name but must:

  • Exclude special characters

  • Be unique within the page

For example, a display name of x_{name} will generate a parameter name of x_name.

Formula

Define the parameter’s value using the formula field, which supports MathJS syntax for mathematical expressions and functions (learn more). Formulas can also be defined inline in the document or directly within the parameter.

View

Choose how the parameter is visualized on the page. Options include:

  • Single value (default)

  • List

  • Table

  • Radio buttons

  • Traffic lights

The available views depend on the parameter’s data type. Learn more on the View Options page.

Format

Adjust the parameter’s display format, including the number of significant figures shown. Some formatting options may be disabled depending on the parameter’s data type.

Visibility

Control how the parameter appears on the page. For example, you can hide the name and formula when embedding the result in text, or show the full equation and result when illustrating a calculation. By default, all visibility options are enabled when a parameter is first created.

Dependancies

Displays a list of all other parameters that this parameter depends on for evaluation. This helps clarify calculation flow and detect potential circular references.

Last updated