dash-ag-grid
v31.2.0
Published
Dash wrapper around AG Grid, the best interactive data grid for the web.
Downloads
4,785
Maintainers
Keywords
Readme
Dash AG Grid
Dash AG Grid is a Dash component wrapper for the AG Grid JavaScript package, enabling you to display AG Grid components natively in your Dash app.
The underlying AG Grid JavaScript package is a third-party software component developed by AG Grid Ltd. Many features are available for free in the AG Grid Community version. Some features require a paid subscription to the AG Grid Enterprise version (more info available here). Both the community and enterprise versions are included in this component, but the enterprise features require you to provide a valid AG Grid license key. The demos which use Enterprise features are clearly marked.
Documentation
Please see the Plotly Dash AG Grid Documentation.
Quick Start
pip install dash-ag-grid
This basic grid has the following features enabled by default:
- Alpine theme
- Sort
- Resize, reorder and pin columns
- Boolean values rendered as check boxes
- Row animation on sort
import dash_ag_grid as dag
from dash import Dash
import pandas as pd
app = Dash()
df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/ag-grid/space-mission-data.csv")
app.layout = dag.AgGrid(
rowData=df.to_dict("records"),
columnDefs=[{"field": i} for i in df.columns],
)
app.run(debug=True)
AG Grid Community Features
Here are a few of the AG Grid Community features available:
Column Interactions (resize, reorder, and pin columns)
Column Spanning
Column Grouping
Pagination
Sorting
Row Selection
Row Reordering
Row Spanning
Pinned Rows
Full Width Rows
Cell data types with automatic type inference
Custom Filtering
Cell Editing
Provided components including number editors, date picker, select editor, text editor, large text editor
Custom Components in cells - add your own components such as buttons, graphs, indicators, markdown and more
Tooltips in cells and headers
Provided themes with light/dark versions
Customizable themes
Figma Design System to design and customize themes
Format Cell Data
Conditional formatting
Data Export to CSV
Keyboard Navigation
Accessibility support
Localization
AG Grid Enterprise features
Here are a few of the features available in AG Grid Enterprise. See the AG Grid docs for more information.
- Grouping / Aggregation
- Advanced Filtering
- Records Lazy Loading
- Server-Side Records Operations
- Hierarchical Data Support & Tree View
- Data Export to Excel
- Excel-like Pivoting
- Copy / Paste
- Sparklines
See a live demo of AG Grid Community and Enterprise Features
Contributing
We welcome contributions to dash-ag-grid
. Please see our contributing guide for more information.