Skip to main content
The Lookup widget is a versatile tool that can be configured for different purposes depending on your data organization needs.

​
Lookup Widget Types

Data Table

Simple dropdown list options for calculations created directly in the builder

Shared Table

Access data from uploaded Excel files with full table functionality

Toggle

Logical true/false toggle with “Yes” or “No” options

​
When to Use Each Type

​
Data Table

Use a Data Table when you need:
  • Simple dropdown list options for calculations
  • Data that can be easily defined within the calculator builder
  • Custom selection lists without external file dependencies

​
Shared Table

Use a Shared Table when you need:
  • Access to complex Excel data files
  • Large datasets that are maintained externally
  • Standardized tables shared across multiple templates
  • Advanced filtering and data organization

​
Toggle

Use a Toggle when you need:
  • Binary choice options (Yes/No, True/False, On/Off)
  • Simple boolean logic in calculations
  • Clean, intuitive user interface for binary decisions

​
Common Properties

All lookup widgets share these core properties:
​
type
string
required
Always set to “lookup” for all lookup widget variants
​
label
string
required
The name of widget, shows up as the section title
​
symbol
string
required
Symbol for the widget (supports KaTeX formatting)
​
defaultValue
string
Default index for the lookup. Must resolve to an integer, and may be a user formula.
​
visibleIf
string
default:"true"
An equation that must result in true/false and can hide the widget if certain conditions are met. Note that if visibleIf==false, then any other fields which try to reference this field will error.
​
export
boolean
default:"false"
Whether or not to export the value of the widget for use elsewhere in the platform, such as in load linking
​
hidden
boolean
default:"false"
Whether or not hide the widget entirely from users’ view. Value can still be set in presets and read by other widgets.
​
referenceId
string
required
Unique reference ID of the widget
​
description
string
Description of section (not currently displayed, but will be)
​
references
string
required
Relevant code or standard reference for the section
​
authorNotes
string
Make notes relevant to internal development here; this will never be displayed publicly
​
referenceImage
string
Any image specifically relevant to the widget (image dataURI)

​
Implementation Guidelines

  1. Choose the Right Type: Select the appropriate lookup variant based on your data source and complexity requirements
  2. Data Organization: Consider how your data will be maintained and updated when choosing between local data tables and shared Excel files
  3. User Experience: Think about the user interface implications - toggles for binary choices, dropdowns for multiple options
  4. Performance: Shared tables may have slightly longer load times but offer more functionality

​
Next Steps

Data Table Implementation

Learn how to create and configure data table lookups

Shared Table Setup

Understand Excel integration and shared table configuration

Toggle Configuration

Implement binary choice toggles for your templates
⌘I