Floating Filters are an additional row under the column headers where the user will be able to see and optionally edit the filters associated with each column.
Floating filters are activated by setting the property floatingFilter = true on the colDef:
const columnDefs = [
# column definition with floating filter enabled
{
'field': 'country',
'filter': True,
'floatingFilter': True
}
];
To have floating filters on for all columns by default, you should set floatingFilter
on the defaultColDef
. You can then disable floating filters on a per-column basis by setting floatingFilter = False
on an individual colDef.
Floating filters depend on and co-ordinate with the main column filters. They do not have their own state, but rather display the state of the main filter and set state on the main filter if they are editable. For this reason, there is no API for getting or setting state of the floating filters.
Every floating filter takes a parameter to show/hide automatically a button that will open the main filter.
To see how floating filters work see Floating Filter Components.
The following example shows the following features of floating filters:
suppressMenu = True
and filter = False
lets you control where the user can access the full filter. In this example suppressMenu = True
for all the columns except Year, Silver and Bronzeimport dash_ag_grid as dag
from dash import Dash, html
import pandas as pd
app = Dash(__name__)
df = pd.read_csv(
"https://raw.githubusercontent.com/plotly/datasets/master/ag-grid/olympic-winners.csv"
)
columnDefs = [
{"field": "athlete", "filter": "agTextFilter", "suppressMenu": True},
{"field": "age", "filter": "agNumberColumnFilter", "suppressMenu": True},
{"field": "country", "filter": "agSetColumnFilter", "suppressMenu": True},
{
"field": "year",
"maxWidth": 120,
"filter": "agNumberColumnFilter",
"floatingFilter": False,
},
{"field": "sport", "suppressMenu": True, "filter": "agTextColumnFilter"},
{
"field": "gold",
"filter": "agNumberColumnFilter",
"filterParams": {
"buttons": ["apply"],
},
"suppressMenu": True,
},
{
"field": "silver",
"filter": "agNumberColumnFilter",
"floatingFilterComponentParams": {
"suppressFilterButton": True,
},
},
{
"field": "bronze",
"filter": "agNumberColumnFilter",
"floatingFilterComponentParams": {
"suppressFilterButton": True,
},
},
{"field": "total", "filter": False},
]
defaultColDef = {
"flex": 1,
"minWidth": 150,
"filter": True,
"sortable": True,
"floatingFilter": True,
}
app.layout = html.Div(
[
dag.AgGrid(
id="floating-filter-example",
rowData=df.to_dict("records"),
columnDefs=columnDefs,
columnSize="sizeToFit",
defaultColDef=defaultColDef,
)
]
)
if __name__ == "__main__":
app.run(debug=True)
All the default filters provided by the grid provide their own implementation of a floating filter. All you need to do to enable these floating filters is set the floatingFilter = true column property. The features of the provided floating filters are as follows:
Filter | Editable | Description |
---|---|---|
Text | Sometimes | Provides a text input field to display the filter value, or a read-only label if read-only. |
Number | Sometimes | Provides a text input field to display the filter value, or a read-only label if read-only. |
Date | Sometimes | Provides a date input field to display the filter value, or a read-only label if read-only. |
Set | No | Provides a read-only label by concatenating all selected values. |
The floating filters for Text, Number and Date (the simple filters) are editable when the filter has one condition and one value. If the floating filter has a) two conditions or b) zero (custom option) or two (‘In Range’) values, the floating filter is read-only.
The screen shots below show example scenarios where the provided Number floating filter is editable and read-only.