[]
ナレッジベース デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Grid_Filter.Columnfilter

ColumnFilter クラス

FlexGrid コントロールの列のフィルタを定義します。

ColumnFilter にはConditionFilter とValueFilter が含まれます。 一度にアクティブにできるのはどちらか一方だけです。

このクラスはFlexGridFilter クラスによって使用されます。 このクラスをユーザーコードで直接使用することはほとんどありません。

階層

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

プロパティ

ariaLabel

ariaLabel: string

ColumnFilterEditor ホスト要素の aria-label 属性を取得または設定します。

このプロパティのデフォルト値は「列のフィルター エディター」です。

column

column: Column

フィルタリングするColumn を取得します。

conditionFilter

conditionFilter: ConditionFilter

このColumnFilter 内のConditionFilter を取得します。

dataMap

dataMap: DataMap

未加工の値をこのフィルタを編集する際に表示される表示値に変換するために使用されるDataMap を取得または設定します。

次の例では、DataMap をBoolean型の列フィルタに割り当て、 フィルタエディタに、'true'と'false'ではなく'Yes'と'No'が表示されるようにしています。

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;
    }
}

filterMode

filterMode: FilterMode

Gets or sets the mode of filtering provided by this filter.

Setting this property to null causes the filter mode to use the value defined by the owner filter's FlexGridFilter.defaultFilterMode property.

filterType

filterType: FilterType

このフィルタから提供されるフィルタ処理のタイプを取得または設定します。

このプロパティをnullに設定すると、フィルタは、オーナーフィルタの FlexGridFilter.defaultFilterType プロパティで定義された値を使用します。

isActive

isActive: boolean

このフィルタがアクティブかどうかを示す値を取得します。

valueFilter

valueFilter: ValueFilter

このColumnFilter 内のValueFilter を取得します。

メソッド

apply

  • apply(value: any): boolean

  • 値がフィルタに合致するかどうかを示す値を取得します。

    引数

    • value: any

      テストする値。

    戻り値 boolean

clear

  • clear(): void

  • フィルタをクリアします。

    戻り値 void

implementsInterface

  • implementsInterface(interfaceName: string): boolean

  • このオブジェクトが指定したインタフェースをサポートしている場合、trueを返します。

    引数

    • interfaceName: string

      調べるインタフェースの名前。

    戻り値 boolean