FlexSheetColumnFilter Class
Heirarchy
-
ColumnFilter
- FlexSheetColumnFilter
Constructors
Properties
Methods
Constructors
constructor
- new
Flex Sheet Column Filter(owner: FlexSheetFilter, column: Column): FlexSheetColumnFilter
-
Initializes a new instance of the FlexSheetColumnFilter class.
Parameters
-
owner: FlexSheetFilter
The FlexSheetFilter that owns this column filter.
-
column: Column
The Column to filter.
Returns FlexSheetColumnFilter
-
Properties
column
Gets the Column being filtered.
conditionFilter
Gets the ConditionFilter in this ColumnFilter.
dataMap
Gets or sets the DataMap used to convert raw values into display values shown when editing this filter.
The example below assigns a DataMap to Boolean column filters so the filter editor displays 'Yes' and 'No' instead of 'true' and 'false':
import { FlexGridFilter } from '@grapecity/wijmo.grid.filter';
var filter = new FlexGridFilter(grid),
map = new wijmo.grid.DataMap([
{ value: true, caption: 'Yes' },
{ value: false, caption: 'No' },
], 'value', 'caption');
for (var c = 0; c < grid.columns.length; c++) {
if (grid.columns[c].dataType == wijmo.DataType.Boolean) {
filter.getColumnFilter(c).dataMap = map;
}
}filterType
Gets or sets the types of filtering provided by this filter.
Setting this property to null causes the filter to use the value defined by the owner filter's FlexGridFilter.defaultFilterType property.
isActive
Gets a value that indicates whether the filter is active.
valueFilter
Gets the ValueFilter in this ColumnFilter.
Methods
apply
- apply(value: any): boolean
-
Gets a value that indicates whether a value passes the filter.
Parameters
-
value: any
The value to test.
Returns boolean
-
clear
- clear(): void
-
Clears the filter.
Returns void
implementsInterface
- implements
Interface(interfaceName: string): boolean
-
Returns true if this object supports a given interface.
Parameters
-
interfaceName: string
Name of the interface to look for.
Returns boolean
-
Defines a filter for a column on a FlexSheet control.
The FlexSheetColumnFilter contains a FlexSheetConditionFilter and a FlexSheetValueFilter; only one of them may be active at a time.
This class is used by the FlexSheetFilter class; you rarely use it directly.