The “members” equation widget is a special type of equation widget designed specifically for handling member collections with specific syntax in its “result”.

Example Code

{
  "type": "sheetTemplateWidgets",
  "attributes": {
    "type": "computed",
    "label": "Members Export",
    "export": true,
    "hidden": true,
    "equation": [
      {
        "condition": "@default",
        "result": "[
            { id: 'member',
            designation: '___',
            length: ____,
            lengthUnit: '___',
            nCom: ___,
            comments: '___'
            },
            {...}
            ]"
      }
    ],
    "referenceId": "members",
    "authorNotes": ""
  }
}

Configuration Parameters

type
string
required
Set to “computed” to define the widget type
label
string
required
The name of widget, shows up as the section title
export
boolean
required
Always select true for members widgets
hidden
boolean
required
Whether or not the widget’s value is displayed in any display level (including detailed). As this is an internal value only, this should be set to true.
equation
array
required
Array of dictionaries where each dictionary represents one member. See equation keys below.
referenceId
string
required
Unique reference ID of the widget
authorNotes
string
Make notes relevant to internal development here; this will never be displayed publicly

Equation Keys

id
string
required
refId of whatever widget is mentioned in designation - usually members but often varies. If this is a lookup with a selector key, it will be editable in the member schedule.
designation
string or print function
required
Will show in member column in schedule. This can be any string or equation you put into a equation widget, but must evaluate to a string.
length
string
required
refId of length widget for the member in designation
lengthUnit
string
required
Unit you want the length displayed as
nCom
string
required
refId of input for number of laminates typically for wood members. TBC if you can leave this out otherwise
comments
string
required
refId of comments widget - usually comments

Important Note about id Key

The members widget is also used to decide on the widget to use when editing inside the member inside the Member Schedule Page. Use the widget’s referenceId inside the id key. Ensure the referencedId refers to a lookup with a “selector” (i.e. one that shows up the modal).