Function put_datatable

pywebio/output.py:1485–1692

Output a datatable. Compared with `put_table()`, `put_datatable()` is more suitable for displaying large amounts of data (both data fields and data entries), while `put_table()` is more suitable for displaying diverse data types (pictures, buttons, etc.) in cells. This widget

(
        records: SequenceType[MappingType],
        actions: SequenceType[Tuple[str, Callable[[Union[str, int, List[Union[str, int]]]], None]]] = None,
        onselect: Callable[[Union[str, int, List[Union[str, int]]]], None] = None,
        multiple_select=False,
        id_field: str = None,
        height: Union[str, int] = 600,
        theme: "Literal['alpine', 'alpine-dark', 'balham', 'balham-dark', 'material']" = 'balham',
        cell_content_bar=True,
        instance_id='',
        column_order: Union[SequenceType[str], MappingType] = None,
        column_args: MappingType[Union[str, Tuple], MappingType] = None,
        grid_args: MappingType[str, Any] = None,
        enterprise_key='',
        scope: str = None,
        position: int = OutputPosition.BOTTOM
)

def put_datatable(
        records: SequenceType[MappingType],
        actions: SequenceType[Tuple[str, Callable[[Union[str, int, List[Union[str, int]]]], None]]] = None,
        onselect: Callable[[Union[str, int, List[Union[str, int]]]], None] = None,
        multiple_select=False,
        id_field: str = None,
        height: Union[str, int] = 600,
        theme: "Literal['alpine', 'alpine-dark', 'balham', 'balham-dark', 'material']" = 'balham',
        cell_content_bar=True,
        instance_id='',
        column_order: Union[SequenceType[str], MappingType] = None,
        column_args: MappingType[Union[str, Tuple], MappingType] = None,
        grid_args: MappingType[str, Any] = None,
        enterprise_key='',
        scope: str = None,
        position: int = OutputPosition.BOTTOM
) -> Output:
    """
    Output a datatable.

    Compared with `put_table()`, `put_datatable()` is more suitable for displaying large amounts of data
    (both data fields and data entries), while `put_table()` is more suitable for displaying diverse data types
    (pictures, buttons, etc.) in cells.

    This widget is powered by the awesome `ag-grid <https://www.ag-grid.com/>`_ library.

    :param list[dict] records: data of rows, each row is a python ``dict``, which can be nested.
    :param list actions: actions for selected row(s), they will be shown as buttons when row is selected.
        The format of the action item: `(button_label:str, on_click:callable)`.
        Specifically, ``None`` item is allowed, which will be rendered as a separator.
        The ``on_click`` callback receives the selected row ID as parameter.
    :param callable onselect: callback when row is selected, receives the selected row ID as parameter.
    :param bool multiple_select: whether multiple rows can be selected.
        When enabled, the ``on_click`` callback in ``actions`` and the ``onselect`` callback will receive
        ID list of selected rows as parameter.
    :param str/tuple id_field: row ID field, that is, the key of the row dict to uniquely identifies a row.
        When not provide, the datatable will use the index in ``records`` to assign row ID.

        .. collapse:: Notes when the row record is nested dict

            To specify the ID field of a nested dict, use a tuple to specify the path of the ID field.
            For example, if the row record is in ``{'a': {'b': ...}}`` format, you can use ``id_field=('a', 'b')``
            to set ``'b'`` column as the ID field.

    :param int/str height: widget height. When pass ``int`` type, the unit is pixel,
        when pass ``str`` type, you can specify any valid CSS height value.
        In particular, you can use ``'auto'`` to make the datatable auto-size it&#x27;s height to fit the content.
    :param str theme: datatable theme.
        Available themes are: ``'balham'`` (default), ``'alpine'``, ``'alpine-dark'``, ``'balham-dark'``, ``'material'``.
        You can preview the themes in `ag-grid official example <https://www.ag-grid.com/example/?theme=ag-theme-balham>`_.
    :param bool cell_content_bar: whether to add a text bar to datatable to show the content of current focused cell.
        Default is ``True``.
    :param str instance_id: Assign a unique ID to the datatable, so that you can refer this datatable in
        `datatable_update()`, `datatable_insert()` and `datatable_remove()` functions.

    :param list column_order: column order, the order of the column names in the list will be used as the column order.
        If not provided, the column order will be the same as the order of the keys in the first row of ``records``.
        When provided, the column not in the list will not be shown.