Dash DataTable

5.0.0 · deprecated · verified Sat Apr 11

Dash DataTable (`dash.dash_table.DataTable`) is an interactive table component designed for viewing, editing, and exploring large datasets within Dash web applications. It is rendered with standard HTML <table> markup, making it accessible, responsive, and highly customizable. The `dash-table` PyPI package is currently at version 5.0.0, but the component is officially deprecated and slated for removal from the core Dash API in Dash 5.0 of the main `dash` package. Users are advised to migrate to `dash-ag-grid` for future development.

Warnings

breaking Dash DataTable is officially deprecated and will be removed from the core Dash API in Dash 5.0. It is strongly recommended to migrate to `dash-ag-grid` for new and existing projects.
Fix: Migrate your table implementations to `dash-ag-grid`. Install with `pip install dash-ag-grid` and refer to its documentation.
breaking Significant API changes occurred in `dash-table` v4.0.0. Several properties were removed or renamed, such as `column.clearable`, `column.hidden`, `content_style` (replaced by `fill_width`), and `pagination_settings` (replaced by `page_current` and `page_size`).
Fix: Consult the `dash-table` CHANGELOG or documentation for v4.0.0 migration guides to update property names and usage.
gotcha When using pagination with tooltips, the DataTable may become unresponsive and generate errors upon hovering over cells.
Fix: Check for known fixes or workarounds in the Plotly community forums or GitHub issues. If possible, upgrade to the latest stable versions of Dash and `dash-table` (or migrate to `dash-ag-grid`). Consider simplifying tooltip logic if the bug persists.
gotcha For callbacks interacting with the DataTable, ensuring correct return types for multiple outputs is crucial. For instance, a callback with two outputs must return a tuple (data, columns) not a single Div component.
Fix: Always ensure the return value of a multi-output callback matches the expected tuple or list of values for the specified outputs.

Install

pip install dash-table Install for backward compatibility (deprecated)
pip install dash-ag-grid Recommended alternative

Imports

DataTable
```
from dash import dash_table
```
As of Dash 2, `dash_table` is included as part of the main `dash` package. The standalone import `import dash_table` is largely for backward compatibility and may not be supported in future Dash versions.

Quickstart

This quickstart demonstrates how to create a basic Dash application with a DataTable. It reads data from a CSV using pandas and displays it in an interactive table.

import dash
from dash import dash_table, html
import pandas as pd

# Sample data (e.g., from a CSV)
df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/solar.csv')

app = dash.Dash(__name__)

app.layout = html.Div([
    dash_table.DataTable(
        id='table-basic',
        columns=[{"name": i, "id": i} for i in df.columns],
        data=df.to_dict('records'),
    )
])

if __name__ == '__main__':
    app.run_server(debug=True)

view raw JSON →