feat: DH-21841: Add a way to set table sort state from `ui.table`. by SimonVutov · Pull Request #1358 · deephaven/deephaven-plugins

SimonVutov · 2026-06-10T17:15:09Z

Adds programmatic UI sort state support to ui.table.

This introduces ui.TableSort and a new sorts argument on ui.table, serializing sort descriptors to the existing iris-grid shape: column, direction, and isAbs. The frontend hydrates these descriptors and applies them to IrisGrid, preferring explicit ui.table sorts over persisted client sort state.

Includes unit coverage for sort serialization and invalid directions, plus a manual app fixture for validating programmatic table sorting.

Demo

Running the following code:

from deephaven import ui, new_table
from deephaven.column import int_col, string_col

data = new_table([
    string_col("Name", ["R01", "R02", "R03", "R04", "R05", "R06"]),
    string_col("Category", ["B", "A", "B", "A", "C", "C"]),
    int_col("SepalLength", [51, -149, 64, 58, -32, 58]),
])

t_mixed_sort_list = ui.table(
    data,
    sorts=[
        "Category",
        ui.TableSort(column="Name", direction="DESC"),
        ui.TableSort(column="SepalLength", direction="ASC", is_abs=True),
    ],
)

t_string_sort = ui.table(
    data,
    sorts="Name",
)

Creates the following tables:

github-actions · 2026-06-10T17:20:04Z

ui docs preview (Available for 14 days)

github-actions · 2026-06-10T17:21:28Z

ui docs preview (Available for 14 days)

github-actions · 2026-06-10T17:24:17Z

ui docs preview (Available for 14 days)

github-actions · 2026-06-10T17:28:42Z

ui docs preview (Available for 14 days)

mofojed

You should also write the docs for this. Add to the ui/docs/components/table.md doc

mofojed · 2026-06-12T13:23:48Z


 ![Example of quick filters](../_assets/table_quick_filter.png)

+## Sort state


Suggested change

## Sort state

## Sort

mofojed · 2026-06-12T13:26:40Z

+- A `ui.TableSort` object
+- A list mixing column names and `ui.TableSort` objects
+
+When you pass `sorts`, those values take precedence over persisted client sort state.


This shouldn't be true. Settings sorts should set the sorts state, and then the user can change those sorts and if they reload, those sorts should persist.

You can test this with filters, e.g.

from deephaven import ui import deephaven.plot.express as dx _stocks = dx.data.stocks() t2 = ui.table( # Filters applied when table is opened on the client _stocks, show_quick_filters=True, quick_filters={ "Sym": "CAT", "Exchange": "NYPE", "Price": ">=100" }, sorts="Side" )

Disable the option "Close Panels on Disconnect" in the console menu:

Change one of the filters (e.g. >=100 to >=50)

Then refresh the browser. The >=50 will remain.

mofojed · 2026-06-12T13:30:12Z

+        sorts: The sorts to apply as UI state on load.
+            These are UI-controlled sorts (similar to reverse) rather than engine-transformed table data.


Change the wording of this comment to be more in line with quick filters, e.g. The sorts to apply to the table.

mofojed · 2026-06-12T13:31:36Z

+    // If sorts are explicitly provided by ui.table, prefer them over persisted state.
+    if (sorts !== undefined) {
+      mergedProps.sorts = hydratedSorts;
    }


This is incorrect. I don't think you should need to make any changes here.

Right now, after creating the table with ui.table, I can't change the sorts by clicking on a column header which is wrong. The user should be able to change the sorts after the fact, and those should persist.

mofojed · 2026-06-12T13:31:59Z

 file_15=ui_home_screen.py
 file_16=ui_routing.py
 file_17=ui_events.py
+file_18=ui_table_programmatic_sort.py


Instead of creating a new file, just add to ui_table.py. There should also be matching updates in ui_table.spec.ts.

github-actions · 2026-06-12T15:14:03Z

ui docs preview (Available for 14 days)

github-actions · 2026-06-12T15:16:28Z

ui docs preview (Available for 14 days)

mofojed

I'm still not able to change the sorts when opening a table with sorts applied. User should be able to change the sorts from the UI

mofojed · 2026-06-12T17:25:58Z

 - A list mixing column names and `ui.TableSort` objects

-When you pass `sorts`, those values take precedence over persisted client sort state.
+When you pass `sorts`, those values seed the initial client sort state. If the user changes the sort, that client state is persisted and restored on reload.


I'll let Don and Margaret review the docs, but this wording is weird to me and inconsistent with how we describe features (like with Quick filters).

… and t_programmatic_sort_abs_desc

github-actions · 2026-06-12T20:32:12Z

ui docs preview (Available for 14 days)

github-actions · 2026-06-12T21:04:40Z

ui docs preview (Available for 14 days)

SimonVutov self-assigned this Jun 10, 2026

SimonVutov force-pushed the feat-DH-21841-Add-a-way-to-set-table-sort-state-from-`ui.table`- branch 2 times, most recently from 4b4e12f to d63f1b9 Compare June 10, 2026 17:17

SimonVutov marked this pull request as draft June 10, 2026 17:17

SimonVutov force-pushed the feat-DH-21841-Add-a-way-to-set-table-sort-state-from-`ui.table`- branch from d63f1b9 to c52c256 Compare June 10, 2026 17:19

feat: DH-21841: Add a way to set table sort state from ui.table.

03a7efd

SimonVutov force-pushed the feat-DH-21841-Add-a-way-to-set-table-sort-state-from-`ui.table`- branch from c52c256 to 03a7efd Compare June 10, 2026 17:25

SimonVutov requested a review from mofojed June 11, 2026 19:20

SimonVutov marked this pull request as ready for review June 11, 2026 19:20

SimonVutov requested a review from dsmmcken June 11, 2026 19:20

mofojed requested changes Jun 12, 2026

View reviewed changes

add docs

2bb7eff

SimonVutov requested a review from mofojed June 12, 2026 13:11

github-actions Bot requested a review from margaretkennedy June 12, 2026 13:11

docs fix

c953fc3

mofojed requested changes Jun 12, 2026

View reviewed changes

SimonVutov added 7 commits June 12, 2026 10:37

sort sets only initial state, user can sort after

d87abcb

Update table.py

6cfdead

add to ui_table.py instead of new file

a50d902

pre-commit run --all-files

5e2a469

add snapshot

2cc451a

add order

09328fb

Update table.md

39bfb66

SimonVutov requested a review from mofojed June 12, 2026 15:14

mofojed requested changes Jun 12, 2026

View reviewed changes

generate the 6 missing baseline PNG files for t_programmatic_sort_asc…

c506ea0

… and t_programmatic_sort_abs_desc

fix: able to change the sorts, as a user

38d278d


		![Example of quick filters](../_assets/table_quick_filter.png)

		## Sort state

		sorts: The sorts to apply as UI state on load.
		These are UI-controlled sorts (similar to reverse) rather than engine-transformed table data.

Conversation

SimonVutov commented Jun 10, 2026

Demo

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

mofojed left a comment

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 12, 2026

Uh oh!

github-actions Bot commented Jun 12, 2026

Uh oh!

mofojed left a comment

Choose a reason for hiding this comment

Uh oh!

mofojed Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 12, 2026

Uh oh!

github-actions Bot commented Jun 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants