Skip to content

Commit

Permalink
Add default to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattrunyon
mattrunyon committed Jun 28, 2024
1 parent 184eb5c commit f2874ab
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions plugins/ui/DESIGN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1893,9 +1893,9 @@ ui_table(
| `always_fetch_columns` | `list[ColumnName] \| None` | The columns to always fetch from the server. These will not be affected by the users current viewport/horizontal scrolling. Useful if you have a column with key value data that you want to always include in the data sent for row click operations. |
| `front_columns` | `list[ColumnName] \| None` | The columns to show at the front of the table. These will not be moveable in the UI. |
| `back_columns` | `list[ColumnName] \| None` | The columns to show at the back of the table. These will not be moveable in the UI. |
| `frozen_columns` | `list[ColumnName] \| None` | The columns to freeze to the front of the table. These will always be visible and not affected by horizontal scrolling. |
| `frozen_columns` | `list[ColumnName] \| None` | The columns to freeze by default to the front of the table. These will always be visible and not affected by horizontal scrolling. |
| `hidden_columns` | `list[ColumnName] \| None` | The columns to hide by default from the table. The user can still resize the columns to view them. |
| `column_groups` | `list[ColumnGroup] \| None` | The column groups to show in the table. Columns will be moved adjacent to the first child in the group. Groups will be shown in the table header. |
| `column_groups` | `list[ColumnGroup] \| None` | The column groups to show in the table by default. Columns will be moved adjacent to the first child in the group. Groups will be shown in the table header. |
| `quick_filters` | `dict[ColumnName, QuickFilterExpression] \| None` | Quick filters for the UI to apply to the table. |
| `show_search` | `bool` | `True` to show the search bar by default, `False` to not. `False` by default. |
| `show_quick_filters` | `bool` | `True` to show the quick filters by default, `False` to not. `False` by default. |
Expand Down
5 changes: 3 additions & 2 deletions plugins/ui/src/deephaven/ui/components/table.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,11 @@ def table(
show_search: Whether to show the search bar by default.
front_columns: The columns to pin to the front of the table. These will not be movable by the user.
back_columns: The columns to pin to the back of the table. These will not be movable by the user.
frozen_columns: The columns to freeze at the front of the table.
frozen_columns: The columns to freeze by default at the front of the table.
These will always be visible regardless of horizontal scrolling.
The user may unfreeze columns or freeze additional columns.
hidden_columns: The columns to hide by default. Users may show the columns by expanding them.
column_groups: Columns to group together. The groups will be shown in the table header.
column_groups: Columns to group together by default. The groups will be shown in the table header.
Group names must be unique within the column and group names.
Groups may be nested by providing the group name as a child of another group.
context_menu: The context menu items to show when a cell is right clicked.
Expand Down

0 comments on commit f2874ab

Please sign in to comment.