Skip to main content

​
Step 1: Open the Sheet Configuration

  1. Open your powersheet document
  2. Go to Menu > Configuration > Edit Document Configuration
  3. Locate the columns section in the YAML

​
Step 2: Add a Simple Property Column

Each column key is a binding path that maps to an entity property defined in the domain model. Add a new entry under columns: 
columns:
  title:
    title: Title
    width: 200
  description:
    title: Description
    width: 300
  severity:
    title: Severity
    width: 100
The binding path key (e.g., title, description) must match a property name defined in your domain model entity type.

​
Step 3: Add a Navigation Property Column

To display properties from related entities, use dot-separated binding paths that follow the relationship chain defined in the domain model: 
columns:
  systemRequirements.systemRequirement:
    title: System Requirement
    multiItem: true
    display: title
    list:
      search:
        - title
        - id
  systemRequirements.systemRequirement.designRequirements.designRequirement:
    title: Design Requirement
    multiItem: true
    display: title
The path systemRequirements.systemRequirement navigates from the root entity through the systemRequirements relationship to the SystemRequirement entity type.

​
Column Properties Reference

PropertyTypeDefaultDescription
titlestring—Display label in the column header
widthnumber or string*Width in pixels or proportional (*, 2*)
minWidthnumber150Minimum width in pixels
visiblebooleantrueWhether the column is shown by default
displaystring—Which property of a referenced entity to show
multiItembooleanfalseEnable multi-item display for one-to-many relationships
isReadOnlybooleanfalsePrevent editing in this column
hasFocusbooleanfalseColumn receives initial focus when editing
formatterstring—Name of a formatter for conditional styling
columnGroupstring—Assign column to a visual column group
headerobject—Custom header styling configuration
groupBybooleanfalseEnable row grouping by this column’s values
sortstring—Default sort direction (asc or desc)

​
Step 4: Configure Display for Linked Entities

When a column binds to a navigation property (a related entity), use display to specify which field to show: 
columns:
  hazard:
    title: Hazard
    display: title
For custom rendering, use a JavaScript arrow function with the display property: 
columns:
  riskControls.riskControl:
    title: Risk Control
    display: >
      () => `${context.value.id} - ${context.value.title}`

​
Step 5: Configure Picker Search for Linked Entities

Add list.search to define which properties are searchable when users pick related items: 
columns:
  hazard:
    title: Hazard
    display: title
    list:
      search:
        - title
        - id
Begin with direct property columns (title, description, severity) before adding navigation columns. Jumping to multi-level navigation paths leads to hard-to-diagnose errors. See Incremental Configuration Approach.
Define a style anchor once and reuse it across columns to keep your configuration DRY:
columns:
  title:
    title: Title
    header: &blue
      style: blue
  description:
    title: Description
    header: *blue

​
Step 6: Set Column Header Style

Apply predefined or custom styles to column headers: 
columns:
  description:
    title: Foreseeable Sequence of Events
    width: 140
    header:
      style: lightpurple
See Apply Column Styles for the full list of predefined styles.

​
Verify

After saving the sheet configuration, reload the powersheet document. You should now see:
  • The new column appears in the sheet with the specified title
  • Data from the bound property or navigation path is displayed
  • For multi-item columns, all linked entities are shown in the cell
  • Picker dialogs allow searching by the configured fields

​
See Also

column-configuration-guide KB article, powersheet.yaml, whole_rtm.template.yaml, document.ts
KB ArticlesSupport TicketsSource Code
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/common/types/domain/document.ts
  • powersheet.yaml
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/common/types/api/document.ts
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/configurations/whole_rtm.template.yaml
  • prod-powersheet-src/com.nextedy.powersheet.client/cypress/fixtures/configurations/constraints_composing.template.yaml