ASP.NET MVC Controls | ComponentOne
In This Topic
    FlexSheetColumnFilter Class
    In This Topic
    File
    wijmo.grid.sheet.js
    Module
    wijmo.grid.sheet
    Base Class
    ColumnFilter

    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.

    Constructor

    Properties

    Methods

    Constructor

    constructor

    constructor(owner: FlexSheetFilter, column: Column): FlexSheetColumnFilter
    

    Initializes a new instance of the FlexSheetColumnFilter class.

    Parameters
    Returns
    FlexSheetColumnFilter

    Properties

    column

    Gets the Column being filtered.

    Inherited From
    ColumnFilter
    Type
    Column

    conditionFilter

    Gets the ConditionFilter in this ColumnFilter.

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

    import { FlexGridFilter } from '@mescius/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;
        }
    }
    

    Inherited From
    ColumnFilter
    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.

    Inherited From
    ColumnFilter
    Type
    FilterType

    isActive

    Gets a value that indicates whether the filter is active.

    Inherited From
    ColumnFilter
    Type
    boolean

    valueFilter

    Gets the ValueFilter in this ColumnFilter.

    Inherited From
    ColumnFilter
    Type
    ValueFilter

    Methods

    apply

    apply(value: any): boolean
    

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

    Parameters
    • value: any

      The value to test.

    Inherited From
    ColumnFilter
    Returns
    boolean

    clear

    clear(): void
    

    Clears the filter.

    Inherited From
    ColumnFilter
    Returns
    void

    implementsInterface

    implementsInterface(interfaceName: string): boolean
    

    Returns true if this object supports a given interface.

    Parameters
    • interfaceName: string

      Name of the interface to look for.

    Inherited From
    ColumnFilter
    Returns
    boolean