Skip to main content

Sort and Filter Overview

diagram

Column Sorting

Interactive Sorting

ActionBehavior
Click column header sort iconSorts by that column. Toggles between ascending and descending.
Ctrl+Click column headerAdds column to existing multi-column sort criteria
Click already-sorted columnToggles between ascending and descending direction

Sort State Indicators

IndicatorMeaning
Arrow upColumn sorted ascending
Arrow downColumn sorted descending
Small number on headerPosition in multi-column sort (1, 2, 3…)

Default Sort Configuration

Default sort order is defined in the sortBy section of the sheet configuration:
sortBy:
  - columnId: outlineNumber
    direction: asc
PropertyTypeDefaultDescription
columnIdstring(required)Dot-separated binding path to the column
directionstring"asc"Sort direction: "asc" (ascending) or "desc" (descending)
The default sort from the configuration is always re-applied after the user sorts interactively. This maintains hierarchical ordering stability.

Sort Behavior by Column Type

Column TypeSort Key
TextAlphabetical (lexicographic)
EnumBy enum value sequence order (not alphabetical)
ReferenceBy the display value of the referenced entity
Custom rendererBy the rendered display text
WorkflowBy transition name or state value
Formatted numberBy display text (e.g., $11,066 sorted as string)
Multiple sortBy entries are supported. The first entry is the primary sort; subsequent entries break ties.

Column Filtering

Filter Panel

Each column header exposes a filter panel with:
FeatureDescription
Value listCheckbox list of distinct values in the column
Condition filtersComparison-based conditions (contains, equals, etc.)
Instant applyFilters update immediately on checkbox change
Clear buttonResets the filter for the current column

Filter Commands

CommandDescription
filterApplies a column-based filter to show a subset of rows
filterClearClears the filter for a specific column
filterClearAllRemoves all active filters, restoring all rows

Filtered Row Count

When filters are active, the toolbar displays a row count indicator:
X/Y rows
  • X = visible rows after all filters (including search)
  • Y = total rows passing column filters (before search)
This indicator is hidden when all rows are visible.

Filter Behavior by Column Type

Column TypeFilter Behavior
Enum columnsOrdered by enum definition sequence
Reference columnsFilterable by display value with checkbox selection
Server-rendered columnsCustom filter rendering for rendered values
Text columnsStandard value list and condition filters

Combining Sort and Filter

Sorting and filtering operate independently and can be combined:
  1. Filters reduce the visible row set
  2. Sorting orders the filtered rows
  3. Search further narrows filtered results
  4. Review mode can be layered on top of filters
The filtered rows indicator reflects the combined effect of all active operations.

Row Grouping

Row grouping provides another dimension of data organization through collapsible group headers:
ActionShortcutDescription
Group by columnCtrl+GGroups rows by the selected column
Add to groupsCtrl+Alt+GAdds column to existing multi-level grouping
Clear groupingCtrl+Shift+GRemoves all grouping
Groups show a collapsible header with the group name, value, and item count. Multi-column grouping creates hierarchical nested groups.

Grouping via Configuration

Columns can be pre-configured for grouping using the groupBy property:
columns:
  severity:
    title: Severity
    groupBy: true

Complete YAML Example

sortBy:
  - columnId: outlineNumber
    direction: asc
  - columnId: priority
    direction: desc

columns:
  outlineNumber:
    title: "#"
    width: 60
    sort: asc
  title:
    title: Title
    width: "*"
    hasFocus: true
  severity:
    title: Severity
    width: 120
    groupBy: true
  systemRequirements.systemRequirement.title:
    title: System Requirement
    width: 200
  • Sort BysortBy configuration reference
  • Columns — column property reference including sort and groupBy
  • Search — text search across sorted/filtered data
  • Review Changes — review mode filtering
  • Toolbar — sort and filter indicators in the toolbar

Source: sortBy Configuration Guide KB article, sorting and filtering test specifications, sheet component features
KB ArticlesSource Code
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/cypress/e2e/Sheet/sorting.spec.ts
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/sheet/SheetComponent.tsx
  • model.yaml
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/cypress/e2e/Sheet/reference.spec.ts
  • prod-powersheet-src/com.nextedy.powersheet.client/ltc-repo/packages/sheet/ViewModel.ts