ASP.NET MVC Controls
ColumnFilter Class
File
wijmo.grid.filter.js
Module
wijmo.grid.filter
Implements
IColumnFilter

Defines a filter for a column on a FlexGrid control.

The ColumnFilter contains a ConditionFilter and a ValueFilter; only one of them may be active at a time.

This class is used by the FlexGridFilter class; you rarely use it directly.

Constructor

Properties

Methods

Constructor

constructor

constructor(owner: FlexGridFilter, column: Column): ColumnFilter

Initializes a new instance of the ColumnFilter class.

Parameters
Returns
ColumnFilter

Properties

column

Gets the Column being filtered.

Type
Column

conditionFilter

Gets the ConditionFilter in this ColumnFilter.

Type
ConditionFilter

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':

var filter = new wijmo.grid.filter.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;
    }
}
Type
DataMap

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 defaultFilterType property.

Type
FilterType

isActive

Gets a value that indicates whether the filter is active.

Type
boolean

valueFilter

Gets the ValueFilter in this ColumnFilter.

Type
ValueFilter

Methods

apply

apply(value): boolean

Gets a value that indicates whether a value passes the filter.

Parameters
  • value:

    The value to test.

Returns
boolean

clear

clear(): void

Clears the filter.

Returns
void

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
  • interfaceName: string

    Name of the interface to look for.

Returns
boolean

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback