5.20193.637
WjFlexGridFilter Wijmo API クラス

WjFlexGridFilter クラス

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 コントロールから派生され、 そのすべてのプロパティ、イベント、およびメソッドを継承しています。

階層

プロパティ

activeEditor

activeEditor: ColumnFilterEditor

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

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

defaultFilterType

defaultFilterType: FilterType

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

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

var f = new wijmo.grid.filter.FlexGridFilter(flex);
f.defaultFilterType = wijmo.grid.filter.FilterType.Condition;
var col = flex.columns.getColumn('ByValue'),
    cf = f.getColumnFilter(col);
cf.filterType = wijmo.grid.filter.FilterType.Value;

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

exclusiveValueSearch

exclusiveValueSearch: boolean

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

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

filterAppliedNg

filterAppliedNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo filterAppliedイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterApplied Wijmoイベント名を使用してください。

filterChangedNg

filterChangedNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo filterChangedイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterChanged Wijmoイベント名を使用してください。

filterChangingNg

filterChangingNg: EventEmitter<any>

プログラムによるアクセスに使用されるWijmo filterChangingイベントのAngular(EventEmitter)バージョン。 コードでこのイベントのAngularバージョンをサブスクライブする場合は、このイベント名を使用してください。 テンプレート連結では、通常のfilterChanging Wijmoイベント名を使用してください。

filterColumns

filterColumns: string[]

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

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

filterDefinition

filterDefinition: string

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

filterDefinition には、現在アクティブなすべての列フィルターに関する情報が含まれます。 ただし、データマップはシリアル化できないため、データマップは含まれません。

grid

grid: FlexGrid

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

initialized

initialized: EventEmitter<any>

このイベントは、コンポーネントがAngularによって初期化された後、つまり すべての連結プロパティが割り当てられ、子コンポーネント(ある場合)が初期化された後にトリガされます。

isInitialized

isInitialized: boolean

コンポーネントがAngularによって初期化されているかどうかを示します。 この値は、initializedイベントをトリガする直前にfalseからtrueになります。

showFilterIcons

showFilterIcons: boolean

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

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

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

showSortButtons

showSortButtons: boolean

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

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

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

wjProperty

wjProperty: string

このコンポーネントの割り当て先のプロパティの名前を取得または設定します。 デフォルト値は''です。

メソッド

apply

  • apply(): void
  • 現在の列フィルタをグリッドに適用します。

    戻り値 void

clear

  • clear(): void
  • すべての列フィルタをクリアします。

    戻り値 void

closeEditor

  • closeEditor(): void

created

  • created(): void
  • Wijmoコンポーネントから継承されるカスタムコンポーネントを作成する場合は、このメソッドを
    オーバーライドして、通常はクラスコンストラクタで行う必要な初期化を行うことができます。 このメソッドは、Wijmoコンポーネントコンストラクタの最後の行で呼び出され、 カスタムコンポーネントのコンストラクタを宣言しなくて済むようにします。これにより、 コンストラクタのパラメータを保持したり、Wijmoコンポーネントのコンストラクタパラメータとの同期を維持する必要がなくなります。

    戻り値 void

editColumnFilter

  • editColumnFilter(col: any, ht?: HitTestInfo, refElem?: HTMLElement): void
  • 指定したグリッド列のフィルタエディタを表示します。

    引数

    • col: any

      編集するフィルタを含むColumn

    • オプション ht: HitTestInfo

      フィルタ表示をトリガしたセルの範囲を含む wijmo.grid.HitTestInfo オブジェクト。

    • オプション refElem: HTMLElement

      エディターを配置するための参照として使用するHTMLElement。

    戻り値 void

getColumnFilter

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

    引数

    • col: any

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

    • オプション create: boolean

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

    戻り値 ColumnFilter

onFilterApplied

onFilterChanged

onFilterChanging

イベント

filterApplied

filterApplied: Event<FlexGridFilter, EventArgs>

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

filterChanged

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

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

filterChanging

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

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

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

filter.filterChanging.addHandler(function (s, e) {
  var cf = filter.getColumnFilter(e.col);
  if (!cf.valueFilter.isActive && cf.conditionFilter.condition1.operator == null) {
    cf.filterType = wijmo.grid.filter.FilterType.Condition;
    cf.conditionFilter.condition1.operator = wijmo.grid.filter.Operator.CT;
  }
});