Skip to content

Commit

Permalink
docs: Clarify row/cell data docs
Browse files Browse the repository at this point in the history
- Only the visible row data is passed back
  • Loading branch information
mofojed committed Jun 4, 2024
1 parent 7d41072 commit 68d4fb7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions plugins/ui/src/deephaven/ui/components/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ def table(
Args:
table: The table to wrap
on_row_press: The callback function to run when a row is clicked.
The first parameter is the row index, and the second is the row data provided in a dictionary where the
The first parameter is the row index, and the second is the visible row data provided in a dictionary where the
column names are the keys.
on_row_double_press: The callback function to run when a row is double clicked.
The first parameter is the row index, and the second is the row data provided in a dictionary where the
The first parameter is the row index, and the second is the visible row data provided in a dictionary where the
column names are the keys.
on_cell_press: The callback function to run when a cell is clicked.
The first parameter is the cell index, and the second is the row data provided in a dictionary where the
The first parameter is the cell index, and the second is the cell data provided in a dictionary where the
column names are the keys.
on_cell_double_press: The callback function to run when a cell is double clicked.
The first parameter is the cell index, and the second is the row data provided in a dictionary where the
The first parameter is the cell index, and the second is the cell data provided in a dictionary where the
column names are the keys.
on_column_press: The callback function to run when a column is clicked.
The first parameter is the column name.
Expand Down
8 changes: 4 additions & 4 deletions plugins/ui/src/deephaven/ui/elements/UITable.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@ class UITableProps(TypedDict):
on_row_press: NotRequired[RowPressCallback]
"""
Callback function to run when a row is clicked.
The first parameter is the row index, and the second is the row data provided in a dictionary where the
The first parameter is the row index, and the second is the visible row data provided in a dictionary where the
column names are the keys.
"""

on_row_double_press: NotRequired[RowPressCallback]
"""
The callback function to run when a row is double clicked.
The first parameter is the row index, and the second is the row data provided in a dictionary where the
The first parameter is the row index, and the second is the visible row data provided in a dictionary where the
column names are the keys.
"""

on_cell_press: NotRequired[CellPressCallback]
"""
The callback function to run when a cell is clicked.
The first parameter is the cell index, and the second is the row data provided in a dictionary where the
The first parameter is the cell index, and the second is the cell data provided in a dictionary where the
column names are the keys.
"""

on_cell_double_press: NotRequired[CellPressCallback]
"""
The callback function to run when a cell is double clicked.
The first parameter is the cell index, and the second is the row data provided in a dictionary where the
The first parameter is the cell index, and the second is the cell data provided in a dictionary where the
column names are the keys.
"""

Expand Down

0 comments on commit 68d4fb7

Please sign in to comment.