Skip to contents

Columns: Filter

Usage

ag_col_filter(
  x,
  columns = NULL,
  filter = NULL,
  filterParams = NULL,
  filterValueGetter = NULL,
  getQuickFilterText = NULL,
  floatingFilter = NULL,
  floatingFilterComponent = NULL,
  floatingFilterComponentParams = NULL,
  suppressFiltersToolPanel = NULL,
  ...
)

Arguments

x

aggrid Object

columns

Specify the column to modify, Default is all columns.

filter

Filter component to use for this column. Set to true to use the default filter. Set to the name of a Provided Filter or set to a IFilterComp.See: Column Filters

filterParams

Params to be passed to the filter component specified in filter.

filterValueGetter

Function or expression. Gets the value for filtering purposes.More details

getQuickFilterText

A function to tell the grid what Quick Filter text to use for this column if you don't want to use the default (which is calling toString on the value). More details

floatingFilter

Whether to display a floating filter for this column.

floatingFilterComponent

The custom component to be used for rendering the floating filter. If none is specified the default AG Grid is used.

floatingFilterComponentParams

Params to be passed to floatingFilterComponent.

suppressFiltersToolPanel

Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.

...

please see https://www.ag-grid.com/javascript-data-grid/column-properties/.