Skip to content

Commit 2b3ad2e

Browse files
committed
deploy: 4e25da6
1 parent faeaab7 commit 2b3ad2e

File tree

156 files changed

+48208
-32077
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+48208
-32077
lines changed

_sources/advanced_parameters.ipynb

Lines changed: 0 additions & 2777 deletions
This file was deleted.

_sources/advanced_parameters.md

Lines changed: 0 additions & 210 deletions
This file was deleted.

_sources/dash.ipynb renamed to _sources/apps/dash.ipynb

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,28 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "722020df",
5+
"id": "8948530e",
66
"metadata": {},
77
"source": [
88
"# Dash\n",
99
"\n",
10-
"ITables includes a Dash component since v2.3.0.\n",
11-
"\n",
12-
"## Displaying a DataFrame\n",
13-
"\n",
1410
"If you wish to display a DataFrame which content is fixed (not reacting to the other controls in the application), you just need to import `ITable` from `itables.dash` and add it to your layout like here:\n",
1511
"\n",
16-
"```{include} ../apps/dash/1_display_only.py\n",
12+
"```{include} ../../apps/dash/1_display_only.py\n",
1713
":code: python\n",
1814
"```\n",
1915
"\n",
2016
"## Selected rows\n",
2117
"\n",
2218
"Listening to the selected rows is simply done by adding `select=True` to the `ITable` call, and then implementing a callback on `Input(\"my_dataframe\", \"selected_rows\")`.\n",
2319
"\n",
24-
"```{include} ../apps/dash/2_selected_rows.py\n",
20+
"```{include} ../../apps/dash/2_selected_rows.py\n",
2521
":code: python\n",
2622
"```\n",
2723
"\n",
2824
"## Updating the DataFrame\n",
2925
"\n",
30-
"The `ITable` component has many properties. These properties (data, columns, selected rows etc) need to be updated in a consistent way. Therefore we recommend that you list the outputs with `ITableOutputs(\"my_dataframe\")` in your callback, and update them with `updated_itable_outputs` which takes the same arguments as `show`, e.g. `df`, `caption`, `selected_rows`, etc, like in the below (extracted from this [example app](https://github.com/mwouts/itables/tree/main/apps/dash/3_update_table.py)):\n",
26+
"The `ITable` component has many properties. These properties (table content, selected rows etc) need to be updated in a consistent way. Therefore we recommend that you list the outputs with `ITableOutputs(\"my_dataframe\")` in your callback, and update them with `updated_itable_outputs` which takes the same arguments as `show`, e.g. `df`, `caption`, `selected_rows`, etc, like in the below (extracted from this [example app](https://github.com/mwouts/itables/tree/main/apps/dash/3_update_table.py)):\n",
3127
"\n",
3228
"```python\n",
3329
"from itables.dash import ITable, ITableOutputs, updated_itable_outputs\n",
@@ -60,13 +56,7 @@
6056
" return updated_itable_outputs(\n",
6157
" caption=caption, selected_rows=selected_rows, current_dt_args=dt_args, **kwargs\n",
6258
" )\n",
63-
"```\n",
64-
"\n",
65-
"## Limitations\n",
66-
"\n",
67-
"Compared to `show`, the `ITable` component has the same limitations as the [Jupyter Widget](widget.md#limitations)\n",
68-
"or the [Streamlit component](streamlit.md#limitations),\n",
69-
"e.g. structured headers are not available, you can't pass JavaScript callback, etc."
59+
"```"
7060
]
7161
}
7262
],

_sources/dash.md renamed to _sources/apps/dash.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,23 @@ kernelspec:
1414

1515
# Dash
1616

17-
ITables includes a Dash component since v2.3.0.
18-
19-
## Displaying a DataFrame
20-
2117
If you wish to display a DataFrame which content is fixed (not reacting to the other controls in the application), you just need to import `ITable` from `itables.dash` and add it to your layout like here:
2218

23-
```{include} ../apps/dash/1_display_only.py
19+
```{include} ../../apps/dash/1_display_only.py
2420
:code: python
2521
```
2622

2723
## Selected rows
2824

2925
Listening to the selected rows is simply done by adding `select=True` to the `ITable` call, and then implementing a callback on `Input("my_dataframe", "selected_rows")`.
3026

31-
```{include} ../apps/dash/2_selected_rows.py
27+
```{include} ../../apps/dash/2_selected_rows.py
3228
:code: python
3329
```
3430

3531
## Updating the DataFrame
3632

37-
The `ITable` component has many properties. These properties (data, columns, selected rows etc) need to be updated in a consistent way. Therefore we recommend that you list the outputs with `ITableOutputs("my_dataframe")` in your callback, and update them with `updated_itable_outputs` which takes the same arguments as `show`, e.g. `df`, `caption`, `selected_rows`, etc, like in the below (extracted from this [example app](https://github.com/mwouts/itables/tree/main/apps/dash/3_update_table.py)):
33+
The `ITable` component has many properties. These properties (table content, selected rows etc) need to be updated in a consistent way. Therefore we recommend that you list the outputs with `ITableOutputs("my_dataframe")` in your callback, and update them with `updated_itable_outputs` which takes the same arguments as `show`, e.g. `df`, `caption`, `selected_rows`, etc, like in the below (extracted from this [example app](https://github.com/mwouts/itables/tree/main/apps/dash/3_update_table.py)):
3834

3935
```python
4036
from itables.dash import ITable, ITableOutputs, updated_itable_outputs
@@ -68,9 +64,3 @@ def update_table(checklist, caption, selected_rows, dt_args):
6864
caption=caption, selected_rows=selected_rows, current_dt_args=dt_args, **kwargs
6965
)
7066
```
71-
72-
## Limitations
73-
74-
Compared to `show`, the `ITable` component has the same limitations as the [Jupyter Widget](widget.md#limitations)
75-
or the [Streamlit component](streamlit.md#limitations),
76-
e.g. structured headers are not available, you can't pass JavaScript callback, etc.

0 commit comments

Comments
 (0)