Function datatable_update

pywebio/output.py:1695–1747

Update the whole data / a row / a cell of the datatable. To use `datatable_update()`, you need to specify the ``instance_id`` parameter when calling :py:func:`put_datatable()`. When ``row_id`` and ``field`` is not specified (``datatable_update(instance_id, data)``), the whole data

(
        instance_id: str,
        data: Any,
        row_id: Union[int, str] = None,
        field: Union[str, List[str], Tuple[str]] = None
)

def datatable_update(
        instance_id: str,
        data: Any,
        row_id: Union[int, str] = None,
        field: Union[str, List[str], Tuple[str]] = None
):
    """
    Update the whole data / a row / a cell of the datatable.

    To use `datatable_update()`, you need to specify the ``instance_id`` parameter when calling :py:func:`put_datatable()`.

    When ``row_id`` and ``field`` is not specified (``datatable_update(instance_id, data)``),
    the whole data of datatable will be updated, in this case,
    the ``data`` parameter should be a list of dict (same as ``records`` in :py:func:`put_datatable()`).

    To update a row, specify the ``row_id`` parameter and pass the row data in dict to ``data``
    parameter (``datatable_update(instance_id, data, row_id)``).
    See ``id_field`` of :py:func:`put_datatable()` for more info of ``row_id``.

    To update a cell, specify the ``row_id`` and ``field`` parameters, in this case, the ``data`` parameter should be
    the cell value To update a row, specify the ``row_id`` parameter and pass the row data in dict to ``data``
    parameter (``datatable_update(instance_id, data, row_id, field)``).
    The ``field`` can be a tuple to indicate nested key path.
    """
    from .session import run_js

    instance_id = f"ag_grid_{instance_id}_promise"
    if row_id is None and field is None:  # update whole table
        run_js("""window[instance_id] ? window[instance_id].then((grid) => {
            grid.api.setRowData(data.map((row) => grid.flatten_row(row)))
        }) : console.error(`Datatable instance [${instance_id}] not found`);
        """, instance_id=instance_id, data=data)

    if row_id is not None and field is None:  # update whole row
        run_js("""window[instance_id] ? window[instance_id].then((grid) => {
            let row = grid.api.getRowNode(row_id);
            if (row) row.setData(grid.flatten_row(data))
        }) : console.error(`Datatable instance [${instance_id}] not found`);
        """, instance_id=instance_id, row_id=row_id, data=data)

    if row_id is not None and field is not None:  # update field
        if not isinstance(field, (list, tuple)):
            field = [field]
        run_js("""window[instance_id] ? window[instance_id].then((grid) => {
            let row = grid.api.getRowNode(row_id);
            if (row) 
                row.setDataValue(grid.path2field(path), data) && 
                grid.api.refreshClientSideRowModel();
        }) : console.error(`Datatable instance [${instance_id}] not found`);
        """, instance_id=instance_id, row_id=row_id, data=data, path=field)

    if row_id is None and field is not None:
        raise ValueError("`row_id` is required when provide `field`")


def datatable_insert(instance_id: str, records: List, row_id=None):