deploy: c1d6a89

Author: mwouts

_sources/advanced_parameters.ipynb

@@ -20,29 +20,25 @@ Below we give a series of examples of how the DataTables examples can be ported
 
 As always, we initialize the `itables` library with
 
-```{code-cell}
-from itables import init_notebook_mode, show
+```{code-cell} ipython3
+import itables
 
-init_notebook_mode(all_interactive=True)
+itables.init_notebook_mode()
 ```
 
 Then we create two sample dataframes:
 
-```{code-cell}
+```{code-cell} ipython3
 import pandas as pd
 
-from itables.sample_dfs import get_countries
-
 df_small = pd.DataFrame({"a": [2, 1]})
-df = get_countries(html=False)
+df = itables.sample_dfs.get_countries(html=False)
 ```
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [remove-cell]
 
-import itables.options as opt
-
-opt.lengthMenu = [5, 10, 20, 50, 100, 200, 500]
+itables.options.lengthMenu = [5, 10, 20, 50, 100, 200, 500]
 ```
 
 ```{tip}
@@ -53,10 +49,10 @@ The rocket icon at the top of the page will let you run this notebook in Binder!
 
 You can set additional `tags` on the table like e.g. a [caption](https://datatables.net/blog/2014-11-07):
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [full-width]
 
-show(df, "Countries from the World Bank Database")
+itables.show(df, "Countries from the World Bank Database")
 ```
 
 The caption appears at the bottom of the table by default: this is governed by `caption-side:bottom`
@@ -69,8 +65,8 @@ By default, datatables that don't fit in one page come with a search box, a pagi
 You can select which elements are actually displayed using
 DataTables' [`layout` option](https://datatables.net/reference/option/layout) with e.g.:
 
-```{code-cell}
-show(df_small, layout={"topStart": "search", "topEnd": None})
+```{code-cell} ipython3
+itables.show(df_small, layout={"topStart": "search", "topEnd": None})
 ```
 
 The available positions are `topStart, topEnd, bottomStart, bottomEnd`. You can also use `top2Start`, etc... (see more
@@ -79,9 +75,7 @@ in the [DataTables documentation](https://datatables.net/reference/option/layout
 Like for the other arguments of `show`, you can change the default value of the dom option with e.g.:
 
 ```
-import itables.options as opt
-
-opt.layout =  {
+itables.options.layout =  {
     "topStart": "pageLength",
     "topEnd": "search",
     "bottomStart": "info",
@@ -92,15 +86,15 @@ opt.layout =  {
 ```{tip}
 The `layout` option was introduced with `itables==2.0` and `DataTables==2.0`
 and deprecates the former [`dom` option](https://datatables.net/reference/option/dom).
-If you wish to continue using the `dom` option, set `opt.warn_on_dom = False`.
+If you wish to continue using the `dom` option, set `itables.options.warn_on_dom = False`.
 ```
 
 ## Search
 
 The [search option](https://datatables.net/reference/option/search) let you control the initial value for the search field, and whether the query should be treated as a regular expression or not:
 
-```{code-cell}
-show(df, search={"regex": True, "caseInsensitive": True, "search": "s.ain"})
+```{code-cell} ipython3
+itables.show(df, search={"regex": True, "caseInsensitive": True, "search": "s.ain"})
 ```
 
 ## Pagination
@@ -109,30 +103,30 @@ show(df, search={"regex": True, "caseInsensitive": True, "search": "s.ain"})
 
 Select [how many entries](https://datatables.net/examples/advanced_init/length_menu.html) should appear at once in the table with either the `lengthMenu` argument of the `show` function, or with the global option `itables.options.lengthMenu`:
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [full-width]
 
-show(df, lengthMenu=[2, 5, 10, 20, 50])
+itables.show(df, lengthMenu=[2, 5, 10, 20, 50])
 ```
 
 ### Show the table in full
 
 Use [`paging=False`](https://datatables.net/reference/option/paging) to show the table in full:
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [full-width]
 
-show(df.head(8), paging=False)
+itables.show(df.head(8), paging=False)
 ```
 
 ### Scroll
 
 You can replace the pagination with a [vertical scroll](https://datatables.net/examples/basic_init/scroll_y.html):
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [full-width]
 
-show(df, scrollY="200px", scrollCollapse=True, paging=False)
+itables.show(df, scrollY="200px", scrollCollapse=True, paging=False)
 ```
 
 Since ITables 2.1.2, the `.dt-layout-table` div has a default overflow equal to `auto`, so in most cases you won't need to use the `scrollX` option of datatables.
@@ -141,62 +135,60 @@ Since ITables 2.1.2, the `.dt-layout-table` div has a default overflow equal to
 
 Use `footer = True` if you wish to display a table footer.
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [full-width]
 
-show(df, footer=True)
+itables.show(df, footer=True)
 ```
 
 ## Column filters
 
 Use `column_filters = "header"` or `"footer"` if you wish to display individual column filters
 (remove the global search box with a [`layout`](layout) modifier if desired).
 
-```{code-cell}
+```{code-cell} ipython3
 alpha_numeric_df = pd.DataFrame(
     [["one", 1.5], ["two", 2.3]], columns=["string", "numeric"]
 )
 
-show(alpha_numeric_df, column_filters="footer", layout={"topEnd": None})
+itables.show(alpha_numeric_df, column_filters="footer", layout={"topEnd": None})
 ```
 
 As always you can set activate column filters by default with e.g.
 
-```{code-cell}
-opt.column_filters = "footer"
+```{code-cell} ipython3
+itables.options.column_filters = "footer"
 ```
 
 Column filters also work on dataframes with multiindex columns:
 
-```{code-cell}
-from itables.sample_dfs import get_dict_of_test_dfs
-
-get_dict_of_test_dfs()["multiindex"]
+```{code-cell} ipython3
+itables.sample_dfs.get_dict_of_test_dfs()["multiindex"]
 ```
 
-```{code-cell}
+```{code-cell} ipython3
 :tags: [remove-cell]
 
-opt.column_filters = False
+itables.options.column_filters = False
 ```
 
 ## Row order
 
 Since `itables>=1.3.0`, the interactive datatable shows the rows in the same order as the original dataframe:
 
-```{code-cell}
-from itables.sample_dfs import get_dict_of_test_dfs
-
-for name, test_df in get_dict_of_test_dfs().items():
+```{code-cell} ipython3
+for name, test_df in itables.sample_dfs.get_dict_of_test_dfs().items():
     if "sorted" in name:
-        show(test_df, tags=f"<caption>{name}</caption>".replace("_", " ").title())
+        itables.show(
+            test_df, tags=f"<caption>{name}</caption>".replace("_", " ").title()
+        )
 ```
 
 You can also set an explicit [`order`](https://datatables.net/reference/option/order) argument:
 
-```{code-cell}
+```{code-cell} ipython3
 sorted_df = pd.DataFrame({"i": [1, 2], "a": [2, 1]}).set_index(["i"])
-show(sorted_df, order=[[1, "asc"]])
+itables.show(sorted_df, order=[[1, "asc"]])
 ```
 
 ## Showing the index
@@ -207,14 +199,12 @@ it has a name, or when it differs from a range index. If you prefer, you can cha
 
 You can change this behavior globally with e.g.
 ```python
-import itables.options as opt
-
-opt.showIndex = True
+itables.options.showIndex = True
 ```
 
 or locally by passing an argument `showIndex` to the `show` function:
 
-```{code-cell}
+```{code-cell} ipython3
 df_with_range_index = pd.DataFrame({"letter": list("abcd")})
-show(df_with_range_index, showIndex=True)
+itables.show(df_with_range_index, showIndex=True)
 ```

_sources/advanced_parameters.md

@@ -1,15 +1,17 @@
 ITables ChangeLog
 =================
 
-2.3.0-dev
----------
+2.3.0 (2025-04-05)
+------------------
 
 **Added**
 - ITable now has a component for Dash! You can render your Python DataFrames in your Dash application with `from itables.dash import ITable` ([#245](https://github.com/mwouts/itables/issues/245))
 
-
 **Changed**
-- We have upgraded `datatables.net-dt==2.2.2` and `datatables.net-select-dt==3.0.0`, and the dependency of both the Jupyter widget and the Streamlit component.
+- We have changed the default value of the `all_interactive` argument of `itables.init_notebook_mode` to `True`
+- The ITables options can be imported and modified directly through `itables.options`
+- We have updated `dt_for_itables` to `datatables.net-dt==2.2.2` and `datatables.net-select-dt==3.0.0`
+- We have updated the dependencies of our Jupyter widget and our of Streamlit component.
 
 
 2.2.5 (2025-02-22)

_sources/changelog.md

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "ea69b296",
+   "id": "677c7c3b",
    "metadata": {},
    "source": [
     "# Contributing\n",
@@ -36,7 +36,7 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "c0dddb4f",
+   "id": "291aebc3",
    "metadata": {},
    "outputs": [
     {
@@ -69,7 +69,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "0bb86b1d",
+   "id": "2099ac07",
    "metadata": {},
    "source": [
     "## Support DataTables\n",

_sources/contributing.ipynb

@@ -39,7 +39,7 @@ It's always great to see new stars coming to ITables! <a class="github-button" h
 
 If you wanted to share a link to ITables and DataTables (no obligation whatsoever), you could use something like this:
 
-```{code-cell}
+```{code-cell} ipython3
 from IPython.display import HTML, display
 
 display(