What is a Widget?

Widgets are powerful tools used for representation, calculation, and organization of data in the calculator builder. You can think of widgets as the building blocks of every template. All widgets have a certain set of inputs (either entered by the user or obtained from another widget in the template), and a certain set of outputs which could be as simple as creating an interface for data entry or as complicated as a table with multiple columns and rows.

Widget Main Functions

Input Interface

  • Scalar data entry
  • Data selection
  • Table creation

Data Organization

  • Structure complex data
  • Manage relationships
  • Control visibility

Calculations

  • Mathematical computations
  • Conditional statements
  • Matrix manipulation

Visual Display

  • Text and labels
  • Images and diagrams
  • Graphs and charts

Widget Interfaces

Widgets are built to have two interfaces:

Preview Mode

For end users - summarizes important information meant for the user to see, comprehend, and input data.

Pause Mode

For engineers - to edit their widgets in the template editor.

Widget Components in Preview Mode

When expanded, widgets typically display:
  1. Widget Description - Explanation of the widgetโ€™s purpose
  2. Formula Reference - Mathematical formulas used
  3. Reference Image - Visual aids and diagrams
  4. Checks - Validation and verification rules

Widget Components in Pause Mode

All widgets share these common sections:
  1. Widget identifiers - Label, symbol, referenceId
  2. Default values - Initial values
  3. Visible if - Visibility conditions
  4. Widget core function - Type-specific functionality
  5. Checks - Validation rules
  6. Description - User-facing explanation
  7. References - Code/standard references
  8. Reference Image - Supporting visuals
  9. Author Notes - Internal documentation
  10. Other Options - Export, visibility settings

Widget Selection Process

Widget Selection Process

Available Widget Types

Widget Management

Adding Widgets

Drag the widget type from the upper left side of the builder in โ€œPauseโ€ mode to create a new widget.

Editing Widgets

Use the buttons at the upper right corner of every widget to:
  • Edit properties
  • Delete widget
  • Duplicate widget
  • Move widget
  • View information

Display Options

At the bottom of each widget (Other Options), you can control:

Best Practices

  • Choose the appropriate widget type for your data and calculation needs
  • Use meaningful labels and symbols for clarity
  • Add descriptions and references for documentation
  • Test visibility conditions thoroughly
  • Consider the user experience in both preview and print modes