Your search did not match any results.
Pivot Grid

Header Filter

A header filter allows a user to filter field values by including or excluding them from the applied filter. Click a header filter icon in the field chooser or on the field panel to open a popup menu that displays all unique field values.

Use the following options to configure the header filter:

  • allowSearch
    Enables a user to search through field values.

  • showRelevantValues
    Specifies whether to show all field values or only those that satisfy the other applied filters.

  • width and height
    Configures the popup menu size.

In this demo, a filter is applied to the Country field. This filter includes only the United Kingdom. The City field displays only cities in this country because the showRelevantValues option is true. If you clear the corresponding checkbox under the widget, the City field displays all cities, regardless of the other applied filters.

Copy to CodeSandBox
import React from 'react'; import { PivotGrid, HeaderFilter, FieldChooser, FieldPanel } from 'devextreme-react/pivot-grid'; import { CheckBox } from 'devextreme-react/check-box'; import PivotGridDataSource from 'devextreme/ui/pivot_grid/data_source'; import XmlaStore from 'devextreme/ui/pivot_grid/xmla_store'; const dataSource = new PivotGridDataSource({ fields: [ { dataField: '[Product].[Category]', area: 'column' }, { dataField: '[Product].[Subcategory]', area: 'column' }, { dataField: '[Customer].[City]', area: 'row' }, { dataField: '[Measures].[Customer Count]', area: 'data' }, { dataField: '[Customer].[Country]', area: 'filter', filterValues: ['[Customer].[Country].&[United Kingdom]'] }, { dataField: '[Ship Date].[Calendar Year]', area: 'filter', filterValues: ['[Ship Date].[Calendar Year].&[2004]'] } ], store: new XmlaStore({ type: 'xmla', url: '', catalog: 'Adventure Works DW Standard Edition', cube: 'Adventure Works' }) }); class App extends React.Component { constructor(props) { super(props); this.state = { allowSearch: true, showRelevantValues: true }; this.onAllowSearchChanged = this.onAllowSearchChanged.bind(this); this.onShowRelevantValuesChanged = this.onShowRelevantValuesChanged.bind(this); } render() { const { allowSearch, showRelevantValues } = this.state; return ( <div> <PivotGrid id={'sales'} allowFiltering={true} allowSorting={true} allowSortingBySummary={true} height={570} showBorders={true} dataSource={dataSource} > <HeaderFilter allowSearch={allowSearch} showRelevantValues={showRelevantValues} width={300} height={400} /> <FieldChooser allowSearch={true} /> <FieldPanel visible={true} /> </PivotGrid> <div className={'options'}> <div className={'caption'}>Options</div> <div className={'option'}> <CheckBox value={allowSearch} text={'Allow Search'} onValueChanged={this.onAllowSearchChanged} /> </div> &nbsp; <div className={'option'}> <CheckBox value={showRelevantValues} text={'Show Relevant Values'} onValueChanged={this.onShowRelevantValuesChanged} /> </div> </div> </div> ); } onAllowSearchChanged(data) { this.setState({ allowSearch: data.value }); } onShowRelevantValuesChanged(data) { this.setState({ showRelevantValues: data.value }); } } export default App;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('app') );
<!DOCTYPE html> <html> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> <link rel="stylesheet" type="text/css" href="" /> <link rel="dx-theme" data-theme="generic.light" href="" /> <link rel="stylesheet" type ="text/css" href="styles.css" /> <script src=""></script> <script src=""></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import('./index.js'); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
#sales { max-height: 570px; } .options { padding: 20px; margin-top: 20px; background-color: rgba(191, 191, 191, 0.15); } .caption { font-size: 18px; font-weight: 500; } .option { width: 24%; display: inline-block; margin-top: 10px; }
System.config({ transpiler: 'plugin-babel', paths: { 'npm:': '' }, defaultExtension: 'js', map: { 'react': 'npm:react@16/umd/react.development.js', 'react-dom': 'npm:react-dom@16/umd/react-dom.development.js', 'prop-types': 'npm:prop-types/prop-types.js', 'devextreme': 'npm:devextreme@19.1', 'devextreme-react': 'npm:devextreme-react@19.1', 'jszip': 'npm:jszip@3.1.3/dist/jszip.min.js', 'quill': 'npm:quill@1.3.6/dist/quill.js', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0/systemjs-babel-browser.js' }, packages: { 'devextreme': { defaultExtension: 'js' }, 'devextreme-react': { main: 'index.js' } }, babelOptions: { sourceMaps: false, stage0: true, react: true } });