Wijmo_Angular2_Grid_Filter.Wjflexgridfilter
WjFlexGridFilter クラス
階層
-
FlexGridFilter
- WjFlexGridFilter
プロパティ
メソッド
イベント
プロパティ
activeEditor
アクティブなColumnFilterEditor を取得します。
このプロパティを使用すると、filterChanging イベントを処理するときに フィルターエディターをカスタマイズできます。 フィルターが編集されていない場合はnullを返します。
defaultFilterType
使用するデフォルトフィルタタイプを取得または設定します。
この値は特定の列のフィルタでオーバーライドできます。 たとえば、以下のサンプルコードは、 "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
フィルターにValueFilter.filterText プロパティによって選択された値のみを含めるかどうかを決定する値を取得または設定します。
このプロパティはデフォルトでtrueに設定されています。この動作はExcelと同じです。 この動作を無効にするには、このプロパティをfalseに設定します。 その場合、リストに表示される項目のみが検索され、 フィルタに含まれる項目が検索されません。
filterAppliedNg
プログラムによるアクセスに使用されるWijmo filterAppliedイベントのAngular（EventEmitter）バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterApplied Wijmoイベント名を使用してください。
filterChangedNg
プログラムによるアクセスに使用されるWijmo filterChangedイベントのAngular（EventEmitter）バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterChanged Wijmoイベント名を使用してください。
filterChangingNg
プログラムによるアクセスに使用されるWijmo filterChangingイベントのAngular（EventEmitter）バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterChanging Wijmoイベント名を使用してください。
filterColumns
フィルタを持つ列の名前またはバインディングを含む配列を取得または設定します。
このプロパティをnullまたは空の配列に設定すると、 すべての列にフィルタが追加されます。
filterDefinition
現在のフィルタ定義をJSON文字列として取得または設定します。
filterDefinition には、現在アクティブな列フィルターに関する情報が含まれます。 データマップはシリアル化できないため、dataMap プロパティは含まれていません。
grid
このフィルタを所有するFlexGrid への参照を取得します。
initialized
このイベントは、コンポーネントがAngularによって初期化された後、つまり すべての連結プロパティが割り当てられ、子コンポーネント（ある場合）が初期化された後にトリガされます。
isInitialized
コンポーネントがAngularによって初期化されているかどうかを示します。 この値は、initializedイベントをトリガする直前にfalseからtrueになります。
showFilterIcons
FlexGridFilter がグリッドの列ヘッダにフィルタ編集ボタンを 追加するかどうかを示す値を取得または設定します。
このプロパティをfalseに設定した場合は、ユーザーがフィルタを編集、クリア、 および適用する手段を開発者が提供する必要があります。
このプロパティのデフォルト値は true です。
showSortButtons
フィルタエディタにソートボタンが表示されるかどうかを示す値を取得または設定します。
デフォルトでは、エディタにはExcelと同じようにソートボタンが表示されます。 しかし、ユーザーはヘッダをクリックすることによって列をソートできるので、 フィルタエディタにソートボタンがあるのは望ましくない場合があります。
このプロパティのデフォルト値は true.です。
wjProperty
このコンポーネントの割り当て先のプロパティの名前を取得または設定します。 デフォルト値は''です。
メソッド
apply
-
現在の列フィルタをグリッドに適用します。
戻り値 void
clear
-
すべての列フィルタをクリアします。
戻り値 void
closeEditor
-
フィルタエディタを閉じます。
戻り値 void
created
-
Wijmoコンポーネントから継承されるカスタムコンポーネントを作成する場合は、このメソッドを
オーバーライドして、通常はクラスコンストラクタで行う必要な初期化を行うことができます。 このメソッドは、Wijmoコンポーネントコンストラクタの最後の行で呼び出され、 カスタムコンポーネントのコンストラクタを宣言しなくて済むようにします。これにより、 コンストラクタのパラメータを保持したり、Wijmoコンポーネントのコンストラクタパラメータとの同期を維持する必要がなくなります。戻り値 void
editColumnFilter
-
指定したグリッド列のフィルタエディタを表示します。
引数
-
col: any
編集するフィルタを含むColumn 。
-
オプション ht: HitTestInfo
フィルタ表示をトリガしたセルの範囲を含む wijmo.grid.HitTestInfo オブジェクト。
-
オプション ref: HTMLElement
エディタの配置を設定するために参照として使用するHTMLElement。
戻り値 void
-
getColumnFilter
-
指定した列のフィルタを取得します。
引数
-
col: Column | string | number
フィルタの適用先のColumn （または列名またはインデックス）。指定された列が存在しない場合、メソッドはnullを返します。
-
オプション create: boolean
存在しない場合にフィルタを作成するかどうか。
戻り値 ColumnFilter
-
onFilterApplied
-
filterApplied イベントを発生させます。
引数
-
オプション e: EventArgs
戻り値 void
-
onFilterChanged
-
filterChanged イベントを発生させます。
引数
戻り値 void
onFilterChanging
-
filterChanging イベントを発生させます。
引数
-
e: CellRangeEventArgs
イベントデータを含むCellRangeEventArgs 。
戻り値 boolean
イベントがキャンセルされなかった場合はTrue。
-
イベント
filterApplied
フィルタが適用された後に発生します。
filterChanged
ユーザーが列フィルタを編集した後で発生します。
イベントパラメータを使用して、フィルタを所有する列を判定し、 変更が適用されたかキャンセルされたかを判定します。
filterChanging
ユーザーが列フィルタを編集しようとしたときに発生します。
フィルタのデフォルトの設定をオーバーライドする場合は、 このイベントを使用して列フィルタをカスタマイズします。
たとえば、以下のコードは、フィルタ条件が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;
}
});
wijmo.grid.filter.FlexGridFilter コントロールに対応するAngular 2コンポーネント。
wj-flex-grid-filter コンポーネントは、wijmo.angular2.grid.WjFlexGrid コンポーネントに含める必要があります。
wj-flex-grid-filter コンポーネントを使用して、Angular 2アプリケーションに FlexGridFilter コントロールを 追加できます。Angular 2マークアップの構文については、 「Angular 2マークアップ構文」を参照してください。
WjFlexGridFilter コンポーネントは、FlexGridFilter コントロールから派生され、 そのすべてのプロパティ、イベント、およびメソッドを継承しています。