from typing import Any, List, Union
from meerkat.dataframe import DataFrame
from meerkat.interactive.app.src.lib.component.abstract import Component
from meerkat.interactive.endpoint import EndpointProperty, endpoint
from meerkat.interactive.event import EventInterface
from meerkat.interactive.formatter.base import register_placeholder
class OnEditInterface(EventInterface):
"""Defines the interface for an event.
Subclass this to define the interface for a new event type.
The class will specify the keyword arguments returned by an event from the
frontend to any endpoint that has subscribed to it.
All endpoints that are expected to receive an event of this type should
ensure they have a signature that matches the keyword arguments defined
in this class.
"""
column: str
keyidx: Union[int, str]
posidx: int
value: Any
class OnSelectTable(EventInterface):
selected: List[Any]
@endpoint
def edit(df: DataFrame, column: str, keyidx: Union[int, str], posidx: int, value: Any):
df.loc[keyidx, column] = value
[docs]class Table(Component):
df: DataFrame
selected: List[str] = []
single_select: bool = False
classes: str = "h-fit"
on_edit: EndpointProperty[OnEditInterface] = None
on_select: EndpointProperty[OnSelectTable] = None
[docs] def __init__(
self,
df: DataFrame,
*,
selected: List[int] = [],
single_select: bool = False,
classes: str = "h-fit",
on_edit: EndpointProperty = None,
on_select: EndpointProperty = None
):
"""Table view of a DataFrame.
Args:
df (DataFrame): The DataFrame to display.
selected (List[int], optional): The indices of the rows selected in the \
gallery. Useful for labeling and other tasks. Defaults to [].
allow_selection (bool, optional): Whether to allow the user to select \
rows. Defaults to False.
single_select: Whether to allow the user to select only one row.
"""
if on_edit is None:
on_edit = edit.partial(df=df)
super().__init__(
df=df,
selected=selected,
single_select=single_select,
classes=classes,
on_edit=on_edit,
on_select=on_select,
)
def _get_ipython_height(self):
return "600px"
register_placeholder(
name="table",
fallbacks=["tiny"],
description="Formatter to be used in a gallery view.",
)
