Skip to main content

​
Column Layout

Columns — Column definitions mapping property paths to display settings including title, width, formatters, focus, visibility, and edit behavior. Column Groups — Visual grouping of related columns under shared headers with color styling and collapse behavior. Binding Syntax — Dot-separated path syntax for mapping columns to domain model properties and navigation paths across entity relationships. Multi-Item Columns — Configuration for columns displaying many-to-many relationships using the multiItem property.

​
Display and Rendering

Display Property — Controls which property of a referenced entity appears in a column on the client side (e.g., showing title instead of id). Render Property — Controls server-side rendering of column content via Velocity templates, complementing the client-side display property for cases requiring custom HTML output.

​
Styling and Formatting

Styles — Named style definitions (CSS classes and colors) that can be referenced by formatters or column headers. Formatters — Named formatter definitions with conditional rules that apply styles based on data values or expressions. Formatters also control read-only behavior and cell appearance. For expression syntax details used within formatter conditions, see Dynamic Value Expressions Reference.

​
Data and Queries

Sources — Data source definitions specifying the root entity type to query, filtering criteria, and expansion paths for loading related entities across the domain model hierarchy. Sort By — Default sort order configuration specifying column and direction (asc/desc) for initial row ordering.

​
View Management

Views — Named view presets that override default column visibility and widths, letting users switch between different perspectives on the same data.

​
Expressions

Dynamic Value Expressions Reference — Reference for $context expressions, computed values, and dynamic defaults used in sources, formatters, and entity factories.
Start with a minimal single-source configuration and extend incrementally. For a step-by-step introduction, see the Sheet Configuration Guides. Common first-time mistakes include mismatching the sources.model property with the domain model name and forgetting multiItem: true when a parent entity links to multiple child entity types.

​
Configuration Structure Overview

A sheet configuration YAML file contains these top-level sections: 
# Top-level structure of a sheet configuration file
columnGroups:    # Visual column grouping with shared headers
sortBy:          # Default sort order (column + direction)
columns:         # Column definitions (required)
views:           # Named view presets
formatters:      # Conditional formatting rules
styles:          # Custom style definitions
sources:         # Data source queries and expansion paths
Each section is documented in detail on its dedicated reference page above. 
+---------------------------+
|  Sheet Configuration      |
|  (YAML file)              |
+---------------------------+
         |
    +---------+---------+----------+---------+
    |         |         |          |         |
    v         v         v          v         v
 sources   columns   views   formatters  styles
    |         |                    |         |
    |    +---------+               |         |
    |    |         |               +---------+
    |    v         v                   |
    | binding   display/              v
    | syntax    render         conditional
    |                          formatting
    v
 expansion
 paths (domain model)
Related pages: Reference | Data Model Reference | Query API Reference | Server Rendering Reference