Data editor¶
marimo.ui.data_editor
¶
data_editor(
data: Union[
RowOrientedData, ColumnOrientedData, IntoDataFrame
],
*,
pagination: bool = True,
page_size: int = 50,
label: str = "",
on_change: Optional[
Callable[
[
Union[
RowOrientedData,
ColumnOrientedData,
IntoDataFrame,
]
],
None,
]
] = None,
column_sizing_mode: Literal["auto", "fit"] = "auto"
)
Bases: UIElement[DataEdits, Union[RowOrientedData, ColumnOrientedData, IntoDataFrame]]
A data editor component for editing tabular data.
This component is experimental and intentionally limited in features, if you have any feature requests, please file an issue at https://github.com/marimo-team/marimo/issues.
The data can be supplied as: 1. a Pandas, Polars, or Pyarrow DataFrame 2. a list of dicts, with one dict for each row, keyed by column names 3. a dict of lists, with each list representing a column
Examples:
Create a data editor from a Pandas dataframe:
import pandas as pd
df = pd.DataFrame({"A": [1, 2, 3], "B": ["a", "b", "c"]})
editor = mo.ui.data_editor(data=df, label="Edit Data")
Create a data editor from a list of dicts:
data = [{"A": 1, "B": "a"}, {"A": 2, "B": "a"}, {"A": 3, "B": "c"}]
editor = mo.ui.data_editor(data=data, label="Edit Data")
Create a data editor from a dict of lists:
data = {"A": [1, 2, 3], "B": ["a", "b", "c"]}
editor = mo.ui.data_editor(data=data, label="Edit Data")
ATTRIBUTE | DESCRIPTION |
---|---|
value |
The current state of the edited data.
TYPE:
|
data |
The original data passed to the editor.
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
data
|
The data to be edited. Can be a Pandas dataframe, a list of dicts, or a dict of lists.
TYPE:
|
label
|
Markdown label for the element.
TYPE:
|
on_change
|
Optional callback to run when this element's value changes. |
column_sizing_mode
|
The column sizing mode for the table.
TYPE:
|
pagination
|
Whether to use pagination, enabled by default. |
page_size
|
Page size if pagination is in use, 50 by default. |
batch
¶
Convert an HTML object with templated text into a UI element.
This method lets you create custom UI elements that are represented by arbitrary HTML.
Example
user_info = mo.md(
'''
- What's your name?: {name}
- When were you born?: {birthday}
'''
).batch(name=mo.ui.text(), birthday=mo.ui.date())
In this example, user_info
is a UI Element whose output is markdown
and whose value is a dict with keys 'name'
and 'birthday
'
(and values equal to the values of their corresponding elements).
PARAMETER | DESCRIPTION |
---|---|
elements
|
the UI elements to interpolate into the HTML template.
TYPE:
|
callout
¶
Create a callout containing this HTML element.
A callout wraps your HTML element in a raised box, emphasizing its
importance. You can style the callout for different situations with the
kind
argument.
Examples:
form
¶
form(
label: str = "",
*,
bordered: bool = True,
loading: bool = False,
submit_button_label: str = "Submit",
submit_button_tooltip: Optional[str] = None,
submit_button_disabled: bool = False,
clear_on_submit: bool = False,
show_clear_button: bool = False,
clear_button_label: str = "Clear",
clear_button_tooltip: Optional[str] = None,
validate: Optional[
Callable[[Optional[JSONType]], Optional[str]]
] = None,
on_change: Optional[
Callable[[Optional[T]], None]
] = None
) -> form[S, T]
Create a submittable form out of this UIElement
.
Creates a form that gates submission of a UIElement
's value until a submit button is clicked.
The form's value is the value of the underlying element from the last submission.
Examples:
Convert any UIElement
into a form:
Combine with HTML.batch
to create a form made out of multiple UIElements
:
form = (
mo.ui.md(
'''
**Enter your prompt.**
{prompt}
**Choose a random seed.**
{seed}
'''
)
.batch(
prompt=mo.ui.text_area(),
seed=mo.ui.number(),
)
.form()
)
PARAMETER | DESCRIPTION |
---|---|
label
|
A text label for the form.
TYPE:
|
bordered
|
Whether the form should have a border.
TYPE:
|
loading
|
Whether the form should be in a loading state.
TYPE:
|
submit_button_label
|
The label of the submit button.
TYPE:
|
submit_button_tooltip
|
The tooltip of the submit button. |
submit_button_disabled
|
Whether the submit button should be disabled.
TYPE:
|
clear_on_submit
|
Whether the form should clear its contents after submitting.
TYPE:
|
show_clear_button
|
Whether the form should show a clear button.
TYPE:
|
clear_button_label
|
The label of the clear button.
TYPE:
|
clear_button_tooltip
|
The tooltip of the clear button. |
validate
|
A function that takes the form's value and returns an error message if invalid,
or
TYPE:
|
on_change
|
A callback that takes the form's value and returns an error message if invalid,
or |
send_message
¶
Send a message to the element rendered on the frontend from the backend.