{
"cells": [
{
"cell_type": "markdown",
"id": "e6ca9a5d",
"metadata": {},
"source": [
"# Jupyter Widget\n",
"\n",
"ITables is available as a [Jupyter Widget](https://ipywidgets.readthedocs.io) since v2.2.\n",
"\n",
"## The `ITable` widget\n",
"\n",
"The `ITable` widget has a few dependencies (essentially [AnyWidget](https://anywidget.dev),\n",
"a great widget development framework!) that you can install with\n",
"```bash\n",
"pip install itables[widget]\n",
"```\n",
"\n",
"The `ITable` class accepts the same arguments as the `show` method, but\n",
"the `df` argument is optional."
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "7718767c",
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "a232224a1f824e05b74f840d8cd1ac1f",
"version_major": 2,
"version_minor": 1
},
"text/plain": [
"ITable(classes='display nowrap', selected_rows=[0, 2, 5], style='table-layout:auto;width:auto;margin:auto;capt…"
]
},
"execution_count": 1,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"from itables.sample_dfs import get_dict_of_test_dfs\n",
"from itables.widget import ITable\n",
"\n",
"df = get_dict_of_test_dfs()[\"int_float_str\"]\n",
"\n",
"table = ITable(df, selected_rows=[0, 2, 5], select=True)\n",
"table"
]
},
{
"cell_type": "markdown",
"id": "baa6ab31",
"metadata": {},
"source": [
"```{tip}\n",
"The table shown above does not reflect the initial row selection.\n",
"This is because the `ITable` widget was updated with\n",
"more row selection commands, see below.\n",
"```\n",
"\n",
"## The `selected_rows` traits\n",
"\n",
"The `selected_rows` attribute of the `ITable` object provides a view on the\n",
"rows that have been selected in the table (remember to pass [`select=True`](select.md)\n",
"to activate the row selection). You can use it to either retrieve\n",
"or change the current row selection:"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "2a56030c",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[0, 2, 5]"
]
},
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"table.selected_rows"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "0fa2d515",
"metadata": {},
"outputs": [],
"source": [
"table.selected_rows = [3, 4]"
]
},
{
"cell_type": "markdown",
"id": "d8d542e4",
"metadata": {},
"source": [
"## The `df` property\n",
"\n",
"Use it to retrieve the table data:"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "14d6c014",
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
"\n",
"\n",
"
\n",
" \n",
" \n",
" | \n",
" int | \n",
" float | \n",
" str | \n",
"
\n",
" \n",
" \n",
" \n",
" | 3 | \n",
" 3 | \n",
" 4.848485 | \n",
" d | \n",
"
\n",
" \n",
" | 4 | \n",
" 4 | \n",
" 4.797980 | \n",
" e | \n",
"
\n",
" \n",
"
\n",
"