# Dash AG Grid [](https://pypi.org/project/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](http://www.ag-grid.com/). Many features are available for free in the AG Grid [Community version](https://github.com/ag-grid/ag-grid). Some features require a paid subscription to the AG Grid Enterprise version ([more info available here](https://www.ag-grid.com/license-pricing.php)). 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.
<div align="center">
<a href="https://dash.plotly.com/project-maintenance">
<img src="https://dash.plotly.com/assets/images/maintained-by-plotly.png" width="400px" alt="Maintained by Plotly">
</a>
</div>
### Documentation
Please see the [Plotly Dash AG Grid Documentation](https://dash.plotly.com/dash-ag-grid).
### 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
```python
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)
```
<img src="https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/74fe86e1-eb54-4dec-915f-d692f2c8cead" width="1000"/>
### 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](https://www.ag-grid.com/example/) of AG Grid Community and Enterprise Features
---------
<img src="https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/0c7319e4-0ebd-437a-bbdc-1091ec7ae325" width="1000"/>
### Contributing
We welcome contributions to `dash-ag-grid`. Please see our [contributing guide](https://github.com/plotly/dash-ag-grid/blob/main/CONTRIBUTING.md) for more information.
Raw data
{
"_id": null,
"home_page": "https://dash.plotly.com/dash-ag-grid",
"name": "dash-ag-grid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Plotly <chris@plot.ly>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b1/36/a9da325e066c18bdc8373d22f4751af79d6de999557c4822cfd7ebe5ef5c/dash_ag_grid-31.3.0.tar.gz",
"platform": null,
"description": "# Dash AG Grid [](https://pypi.org/project/dash-ag-grid/)\n\nDash 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.\n\nThe underlying AG Grid JavaScript package is a third-party software component developed by [AG Grid Ltd](http://www.ag-grid.com/). Many features are available for free in the AG Grid [Community version](https://github.com/ag-grid/ag-grid). Some features require a paid subscription to the AG Grid Enterprise version ([more info available here](https://www.ag-grid.com/license-pricing.php)). 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.\n\n<div align=\"center\">\n <a href=\"https://dash.plotly.com/project-maintenance\">\n <img src=\"https://dash.plotly.com/assets/images/maintained-by-plotly.png\" width=\"400px\" alt=\"Maintained by Plotly\">\n </a>\n</div>\n\n\n### Documentation\nPlease see the [Plotly Dash AG Grid Documentation](https://dash.plotly.com/dash-ag-grid).\n\n### Quick Start\n\n`pip install dash-ag-grid`\n\nThis basic grid has the following features enabled by default:\n- Alpine theme\n- Sort\n- Resize, reorder and pin columns\n- Boolean values rendered as check boxes\n- Row animation on sort\n\n```python\n\nimport dash_ag_grid as dag\nfrom dash import Dash\nimport pandas as pd\n\napp = Dash()\n\ndf = pd.read_csv(\"https://raw.githubusercontent.com/plotly/datasets/master/ag-grid/space-mission-data.csv\")\n\napp.layout = dag.AgGrid(\n rowData=df.to_dict(\"records\"),\n columnDefs=[{\"field\": i} for i in df.columns],\n)\n\napp.run(debug=True)\n```\n\n<img src=\"https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/74fe86e1-eb54-4dec-915f-d692f2c8cead\" width=\"1000\"/>\n\n\n### AG Grid Community Features\nHere are a few of the AG Grid Community features available:\n\n- Column Interactions (resize, reorder, and pin columns)\n- Column Spanning\n- Column Grouping\n- Pagination\n- Sorting\n- Row Selection\n- Row Reordering\n- Row Spanning\n- Pinned Rows\n- Full Width Rows\n\n- Cell data types with automatic type inference\n- Custom Filtering\n- Cell Editing\n\n- Provided components including number editors, date picker, select editor, text editor, large text editor\n- Custom Components in cells - add your own components such as buttons, graphs, indicators, markdown and more\n- Tooltips in cells and headers\n\n- Provided themes with light/dark versions\n- Customizable themes\n- Figma Design System to design and customize themes\n\n- Format Cell Data\n- Conditional formatting\n\n- Data Export to CSV\n- Keyboard Navigation\n- Accessibility support\n- Localization\n\n\n\n### AG Grid Enterprise features\nHere are a few of the features available in AG Grid Enterprise. See the AG Grid docs for more information.\n\n- Grouping / Aggregation \n- Advanced Filtering\n- Records Lazy Loading \n- Server-Side Records Operations \n- Hierarchical Data Support & Tree View \n- Data Export to Excel \n- Excel-like Pivoting \n- Copy / Paste\n- Sparklines\n\n### See a [live demo](https://www.ag-grid.com/example/) of AG Grid Community and Enterprise Features\n\n---------\n\n\n\n<img src=\"https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/0c7319e4-0ebd-437a-bbdc-1091ec7ae325\" width=\"1000\"/>\n\n### Contributing \n\nWe welcome contributions to `dash-ag-grid`. Please see our [contributing guide](https://github.com/plotly/dash-ag-grid/blob/main/CONTRIBUTING.md) for more information.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Dash wrapper around AG Grid, the best interactive data grid for the web.",
"version": "31.3.0",
"project_urls": {
"Documentation": "https://dash.plotly.com/dash-ag-grid",
"Homepage": "https://dash.plotly.com/dash-ag-grid",
"Issue Tracker": "https://github.com/plotly/dash-ag-grid/issues",
"Source": "https://github.com/plotly/dash-ag-grid"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2bbebbca053d741cc6ae5333bf3263be520c308b122cd3e4d720fd598231809b",
"md5": "b89839548d56ce82ffa2804127c40edd",
"sha256": "a174c00b816d03a969c5af61a60f8f6b61af5a9b7058633c86424db99e62875b"
},
"downloads": -1,
"filename": "dash_ag_grid-31.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b89839548d56ce82ffa2804127c40edd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3876384,
"upload_time": "2024-11-22T16:13:10",
"upload_time_iso_8601": "2024-11-22T16:13:10.618072Z",
"url": "https://files.pythonhosted.org/packages/2b/be/bbca053d741cc6ae5333bf3263be520c308b122cd3e4d720fd598231809b/dash_ag_grid-31.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b136a9da325e066c18bdc8373d22f4751af79d6de999557c4822cfd7ebe5ef5c",
"md5": "2b4ce52924397d3d22f588072dfd1c27",
"sha256": "8f609601d25225a53130d5a2da1f43c685dc640c777a7de80bbaa070ded3d19c"
},
"downloads": -1,
"filename": "dash_ag_grid-31.3.0.tar.gz",
"has_sig": false,
"md5_digest": "2b4ce52924397d3d22f588072dfd1c27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3858138,
"upload_time": "2024-11-22T16:13:13",
"upload_time_iso_8601": "2024-11-22T16:13:13.818304Z",
"url": "https://files.pythonhosted.org/packages/b1/36/a9da325e066c18bdc8373d22f4751af79d6de999557c4822cfd7ebe5ef5c/dash_ag_grid-31.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 16:13:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plotly",
"github_project": "dash-ag-grid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dash-ag-grid"
}
JSON
