Skip to main content
All docs
V24.2

GridColumnFilterOptions Class

Contains settings of the column filters that allow users to search data in the Grid item.

#Declaration

TypeScript
export class GridColumnFilterOptions extends SerializableModel

#Remarks

Column filters allow users to search data in the Grid item. These filters do not affect data outside the Grid.

  • Set the showFilterRow property to true to enable the filter row.
  • Set the updateTotals property to true to reflect changes in column values and recalculate totals based on the applied column filter.

Use the GridItem.columnFilterOptions property to get access to these settings.

The following example shows how to enable the filter row for each Grid item after a dashboard is initialized:

js
function onDashboardInitialized(args) {
  args.dashboard.items().forEach(element => {
    if (element instanceof GridItem) {
      element.columnFilterOptions.showFilterRow(true);
    }
  });
}

#Inherited Members

#Inheritance

SerializableModel
GridColumnFilterOptions

#constructor

Initializes a new instance of the GridColumnFilterOptions class with specified settings.

#Declaration

TypeScript
constructor(
    JSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type
JSON any
serializer ModelSerializer

#Properties

#showFilterRow Property

Specifies whether to enable the filter row to allow users to search data in the Grid item.

#Declaration

TypeScript
showFilterRow: ko.Observable<boolean>

#Property Value

Type Description
Observable<boolean>

true to enable the filter row; otherwise, false.

#updateTotals Property

Specifies whether to reflect changes in column values and recalculate totals based on the applied column filter.

#Declaration

TypeScript
updateTotals: ko.Observable<boolean>

#Property Value

Type Description
Observable<boolean>

true to update totals; otherwise, false.

#Methods

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.