When to Use multiItem
UsemultiItem: true when a column binding path points to a many-to-many relationship in the data model. In these cases, a single parent entity can link to multiple child entities, and those child entities can also link back to multiple parents. Common scenarios include:
- Verification test cases linked to requirements
- Validation test cases linked to requirements
- Risk controls linked to hazards
multiItem: true, the column treats the binding as a single-value reference and only displays one item.
1
Verify the Data Model Relationship
Before configuring the column, confirm that the relationship in your data model is defined as many-to-many. The relationship must use an association entity type to connect the two sides. For example, a The binding path in your column configuration must follow the navigation property names defined in the data model.
SystemRequirement linked to multiple VerificationTestCase entities:2
Add the multiItem Column
In the
columns section of your sheet configuration, add a column whose key is the full binding path to the collection navigation property. Set multiItem: true:When
multiItem is true, the cell renders all linked entities as a list and provides a multi-reference picker for adding or removing items.3
Configure the Sources Expansion
The Each
sources section must include an expand entry for the collection relationship. Without this expansion, the column has no data to display:expand entry corresponds to a navigation property in the data model. The names must match exactly.4
Configure the Picker Search
For multi-item columns, add a
list property to control the reference picker dropdown. The list.search array defines which entity properties users can search when selecting items:list.search— array of property names the picker searches against as the user typeslist.createNew— set totrueto allow creating a new entity directly from the picker dropdown without leaving the sheet
5
Add Multi-Level Multi-Item Columns
In a full traceability matrix, you may need multi-item columns at multiple levels of the hierarchy. Each level requires its own expansion path in Notice how each column’s binding path mirrors the nesting in the
sources:expand section. Every dot-separated segment must have a corresponding expansion entry.6
Optional Column Settings
You can combine
multiItem with other column properties for additional control:isReadOnly— prevents editing while still displaying linked itemscolumnGroup— assigns the column to a visual group (see Configure a Column Group)formatter— applies conditional styling (see Configure a Formatter)visible— set tofalseto hide the column in the default view while keeping it available in named views (see Create a View)
Verify Your Configuration
After saving the sheet configuration:- Reload the powersheet document
- You should now see the multi-item column displaying linked entities as a comma-separated list in each cell
- Click a cell in the multi-item column — a reference picker should appear, allowing you to search, add, or remove linked entities
- If the column appears empty, check that the
expandpath insourcesmatches the column binding path exactly
The multi-reference picker behavior (including search results and the “Add New” option) depends on the server-side query configuration. If the picker returns unexpected results, verify that the data model relationship and expansion paths are correctly defined.
See Also
- Add a Column — basics of column configuration and binding paths
- Configure Sources — defining data sources and expansion paths
- Configure a Column Group — organizing multi-item columns into visual groups
- Add External Reference Column — linking to entities outside the current document
- Fix Multi-Item Column Errors — troubleshooting common multi-item issues
- Create Bidirectional Links — setting up the data model relationships that multi-item columns depend on