layout_hints

The layout_hints method creates a new table with information about how the UI should layout the table.

Note

You can also show, hide, freeze, group, and reorder columns using the deephaven.ui Python package.

Syntax

Parameters

ParameterTypeDescription
frontUnion[str, list[str]]

The columns to show at the front.

backUnion[str, list[str]]

The columns to show at the back.

freezeUnion[str, list[str]]

The columns to freeze.

hideUnion[str, list[str]]

The columns to hide.

column_groupsList[Dict]

A list of dicts specifying which columns should be grouped in the UI. The dicts can specify the following:

  • name (str): The group name.
  • children (List[str]): The column names in the group.
  • color (Optional[str]): The hex color string or Deephaven color name.
search_display_modeSearchDisplayMode

Sets the search bar to either be explicitly accessible or inaccessible, or to use the system default.

  • SearchDisplayMode.SHOW: show the search bar.
  • SearchDisplayMode.HIDE: hide the search bar.
  • SearchDisplayMode.DEFAULT: use the system default.

Returns

A new table with layout instructions for the UI.

Examples

In the following example, column Even is frozen to the front of the table, Odd is moved to the front, B is moved to the back, C is hidden, and A and E form a column group called Vowels.