[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Grid_Sheet.Flexsheetfilter

FlexSheetFilter クラス

FlexSheet コントロールに対してExcelスタイルのフィルタを実装します。

FlexSheet コントロールでフィルタリングを有効にするには、 FlexSheetFilter のインスタンスを作成し、 コンストラクターのパラメーターとしてグリッドを渡します。

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

プロパティ

activeEditor

activeEditor: ColumnFilterEditor

アクティブなColumnFilterEditor を取得します。

このプロパティを使用すると、filterChanging イベントを処理するときに フィルターエディターをカスタマイズできます。 フィルターが編集されていない場合はnullを返します。

defaultFilterType

defaultFilterType: FilterType

使用するデフォルトフィルタタイプを取得または設定します。

この値は特定の列のフィルタでオーバーライドできます。 たとえば、以下のサンプルコードは、 "ByValue"列を除くすべての列に対して条件に基づくフィルタを作成します。

import { FlexGridFilter, FilterType } from '@grapecity/wijmo.grid.filter';
let filter = new FlexGridFilter(flex);
filter.defaultFilterType = FilterType.Condition;
let col = flex.getColumn('ByValue'),
    cf = filter.getColumnFilter(col);
cf.filterType = FilterType.Value;

このプロパティのデフォルト値は FilterType.Both です。

exclusiveValueSearch

exclusiveValueSearch: boolean

フィルターにValueFilter.filterText プロパティによって選択された値のみを含めるかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。この動作はExcelと同じです。 この動作を無効にするには、このプロパティをfalseに設定します。 その場合、リストに表示される項目のみが検索され、 フィルタに含まれる項目が検索されません。

filterColumns

filterColumns: string[]

フィルタを持つ列の名前またはバインディングを含む配列を取得または設定します。

このプロパティをnullまたは空の配列に設定すると、 すべての列にフィルタが追加されます。

filterDefinition

filterDefinition: string

現在のフィルタ定義をJSON文字列として取得または設定します。

grid

grid: FlexGrid

このフィルタを所有するFlexGrid への参照を取得します。

showFilterIcons

showFilterIcons: boolean

FlexGridFilter がグリッドの列ヘッダにフィルタ編集ボタンを 追加するかどうかを示す値を取得または設定します。

このプロパティをfalseに設定した場合は、ユーザーがフィルタを編集、クリア、 および適用する手段を開発者が提供する必要があります。

このプロパティのデフォルト値は true です。

showSortButtons

showSortButtons: boolean

フィルタエディタにソートボタンが表示されるかどうかを示す値を取得または設定します。

デフォルトでは、エディタにはExcelと同じようにソートボタンが表示されます。 しかし、ユーザーはヘッダをクリックすることによって列をソートできるので、 フィルタエディタにソートボタンがあるのは望ましくない場合があります。

このプロパティのデフォルト値は true.です。

メソッド

apply

  • apply(): void

  • 現在の列フィルタをシートに適用します。

    戻り値 void

clear

  • clear(): void

  • すべての列フィルタをクリアします。

    戻り値 void

closeEditor

  • closeEditor(): void

editColumnFilter

getColumnFilter

  • 指定した列のフィルタを取得します。

    引数

    • col: any

      フィルタの適用先のColumn （または列名またはインデックス）。

    • オプション create: boolean

      存在しない場合にフィルタを作成するかどうか。

    戻り値 FlexSheetColumnFilter

onFilterApplied

onFilterChanged

onFilterChanging

イベント

filterApplied

filterApplied: Event<FlexGridFilter, EventArgs>

フィルタが適用された後に発生します。

filterChanged

filterChanged: Event<FlexGridFilter, CellRangeEventArgs>

ユーザーが列フィルタを編集した後で発生します。

イベントパラメータを使用して、フィルタを所有する列を判定し、 変更が適用されたかキャンセルされたかを判定します。

filterChanging

filterChanging: Event<FlexGridFilter, CellRangeEventArgs>

ユーザーが列フィルタを編集しようとしたときに発生します。

フィルタのデフォルトの設定をオーバーライドする場合は、 このイベントを使用して列フィルタをカスタマイズします。

たとえば、以下のコードは、フィルタ条件がnullの場合に、使用される演算子を 'contains'に設定します。

import { FilterType, Operator } from '@grapecty/wijmo.grid.filter';
filter.filterChanging.addHandler((s, e) => {
    let cf = filter.getColumnFilter(e.col);
    if (!cf.valueFilter.isActive && cf.conditionFilter.condition1.operator == null) {
        cf.filterType = FilterType.Condition;
        cf.conditionFilter.condition1.operator = Operator.CT;
    }
});