Skip to main content

Multi Filter

The Multi Filter allows multiple Column filters (Provided Filters or Custom Filters) to be used on the same column. This provides greater flexibility when filtering data in the grid.

Using Multi Filter​

Multi filter is represented by class AgMultiColumnFilter.

ColDef colDef = ColDef.builder()
    .field("tradeId")
    .filter(new AgMultiColumnFilter()
        .filterParams(
            MultiFilterParams.builder()
                .filters(
                    new AgNumberColumnFilter(),
                    new CustomNumberFilter()
                )
                .build()
        )
    )
    .build()

Multi Filter Parameters​

Multi Filters are configured though the filter params (MultiFilterParams class)

PropertyTypeDefaultDescription
filtersList<IFilter<?, ?>>-List of filters

Example of using filter parameters (also with child filters parameters).

ColDef colDef = ColDef.builder()
    .field("tradeId")
    .filter(new AgMultiColumnFilter()
        .filterParams(
            MultiFilterParams.builder()
                .filters(
                    new AgNumberColumnFilter()
                        .filterParams(
                            NumberFilterParams.builder()
                                .inRangeInclusive(true)
                                .includeBlanksInEquals(true)
                                .build()
                        ),
                    new CustomNumberFilter()
                        .filterParams(
                            new CustomNumberFilterParams(false)
                        )
                )
                .build()
        )
    )
    .build()

Multi Filter Model​

Multi filter model is represented by MultiFilterModel class.

Grid using Server Side Multi Filter​

  • Backend source code available here