ig.excel.WorksheetFilterSettings

ワークシートで領域を識別し、その領域にフィルターを適用し、オプションに並べ替え条件を適用するメソッドを公開します。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。
  • applyAverageFilter

    .applyAverageFilter( relativeColumnIndex:number, type:ig.excel.AverageFilterType );

    列に AverageFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • type
    • タイプ:ig.excel.AverageFilterType
    • データ範囲の平均を下回るデータに絞り込むか、平均を上回るデータに絞り込むかを示す値。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
    ig.excel.InvalidEnumArgumentException
  • applyCustomFilter

    .applyCustomFilter( relativeColumnIndex:number, condition:ig.excel.CustomFilterCondition );

    列に CustomFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • condition
    • タイプ:ig.excel.CustomFilterCondition
    • データを表示するために一致する必要のある条件。

    例外

    例外 説明
    ig.ArgumentNullException 条件は null です。
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。

    備考

    注: フィルター条件値の長さ 255 文字よりも長く、ワークブックが 2003 フォーマットの 1 つで保存される場合、保存されたファイルで正しい行は非表示になりますが、フィルターは列からなくなります。

  • applyCustomFilter

    .applyCustomFilter( relativeColumnIndex:number, condition1:ig.excel.CustomFilterCondition, condition2:ig.excel.CustomFilterCondition, conditionalOperator:ig.excel.ConditionalOperator );

    列に CustomFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • condition1
    • タイプ:ig.excel.CustomFilterCondition
    • データの絞り込みに使用される第 1 条件。
    • condition2
    • タイプ:ig.excel.CustomFilterCondition
    • データの絞り込みに使用される第 2 条件。
    • conditionalOperator
    • タイプ:ig.excel.ConditionalOperator
    • condition1 および condition2 との論理的な連結を定義する演算子。

    例外

    例外 説明
    ig.ArgumentNullException 条件は null です。
    ig.excel.InvalidEnumArgumentException
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。

    備考

    注: フィルター条件値の長さ 255 文字よりも長く、ワークブックが 2003 フォーマットの 1 つで保存される場合、保存されたファイルで正しい行は非表示になりますが、フィルターは列からなくなります。

  • applyDatePeriodFilter

    .applyDatePeriodFilter( relativeColumnIndex:number, type:ig.excel.DatePeriodFilterType, value:number );

    列に DatePeriodFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • type
    • タイプ:ig.excel.DatePeriodFilterType
    • 表示する日付期間のタイプ。
    • value
    • タイプ:number
    • 表示する月または四半期の 1 から始まる値。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
    ig.excel.InvalidEnumArgumentException
    ig.ArgumentException タイプが Quarter であり、値が 1 未満または 4 を超える値であるか、もしくはタイプが Month で、値が 1 未満または 12 を超える値です。

    備考

    タイプが Month である場合、この値に 1 を指定すると January に、2 を指定すると February に日付が絞り込まれるという具合になります。 タイプが Quarter の場合、この値に 1 を指定すると Quarter 1 に日付が絞り込まれるという形になります。

  • applyFillFilter

    .applyFillFilter( relativeColumnIndex:number, fill:ig.excel.CellFill );

    列に FillFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • fill
    • タイプ:ig.excel.CellFill
    • セルのフィルタリングに使用する CellFill

    例外

    例外 説明
    ig.ArgumentNullException 塗りつぶしは null です。
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • applyFixedValuesFilter

    .applyFixedValuesFilter( relativeColumnIndex:number, includeBlanks:boolean, calendarType:ig.excel.CalendarType, dateGroups:ig.excel.FixedDateGroup[] );

    列に FixedValuesFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • includeBlanks
    • タイプ:boolean
    • 空のセルを表示するかどうかを示す値。
    • calendarType
    • タイプ:ig.excel.CalendarType
    • dateGroups コレクションに含まれる値の解釈に使用されるカレンダー タイプ。
    • dateGroups
    • タイプ:ig.excel.FixedDateGroup[]
    • 表示される固定日付グループのコレクション。

    例外

    例外 説明
    ig.ArgumentNullException dateGroups が null です。
    ig.ArgumentNullException dateGroups が null です。
    ig.excel.InvalidEnumArgumentException
    ig.ArgumentException dateGroups の複数項目は互いに等しいです。
    ig.InvalidOperationException includeBlanks が False で dateGroups に項目はありません。少なくとも 1 つの値を許可する必要があります。
    ig.InvalidOperationException includeBlanks が False で dateGroups に項目はありません。少なくとも 1 つの値を許可する必要があります。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • applyFontColorFilter

    .applyFontColorFilter( relativeColumnIndex:number, fontColorInfo:ig.excel.WorkbookColorInfo );

    列に FontColorFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • fontColorInfo
    • タイプ:ig.excel.WorkbookColorInfo
    • フィルターされるセルに使用するフォントの色を説明する WorkbookColorInfo

    例外

    例外 説明
    ig.ArgumentNullException fontColorInfo は null です。
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • applyFontColorFilter

    .applyFontColorFilter( relativeColumnIndex:number, fontColor:string );

    列に FontColorFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • fontColor
    • タイプ:string
    • セルの絞り込みに使用するフォントの色。

    例外

    例外 説明
    ig.ArgumentNullException fontColorInfo は null です。
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • applyIconFilter

    .applyIconFilter( relativeColumnIndex:number, iconSet:ig.excel.FormatConditionIconSet, iconIndex:number );

    列に IconFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • iconSet
    • タイプ:ig.excel.FormatConditionIconSet
    • アイコンを含むアイコン セット。
    • iconIndex
    • タイプ:number
    • セットでアイコンのゼロから始まるインデックス、または 'NoCellIcon' の場合は null。

    例外

    例外 説明
    ig.ArgumentException アイコン セットが有効でない場合。
    ig.IndexOutOfRangeException index が 0 未満、またはアイコン セットに含まれるアイコン数以上の場合。
    ig.InvalidOperationException 所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。 ヘッダー行またはフィルター ボタンが非表示の時にフィルターを適用できません。
    ig.InvalidOperationException 所有テーブルの WorksheetTable.isFilterUIVisible 値は False です。 ヘッダー行またはフィルター ボタンが非表示の時にフィルターを適用できません。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
    ig.excel.InvalidEnumArgumentException
  • applyRelativeDateRangeFilter

    .applyRelativeDateRangeFilter( relativeColumnIndex:number, offset:ig.excel.RelativeDateRangeOffset, duration:ig.excel.RelativeDateRangeDuration );

    列に RelativeDateRangeFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • offset
    • タイプ:ig.excel.RelativeDateRangeOffset
    • 相対フィルターのオフセット。このタイプのフィルターを期間と組み合わせて使用すると、許容される全日付範囲が決定されます。
    • duration
    • タイプ:ig.excel.RelativeDateRangeDuration
    • 許容される全日付範囲の期間です。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException
    ig.excel.InvalidEnumArgumentException
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。

    備考

    RelativeDateRangeFilter では、フィルターの適用日を基点として、1 つ前、現在、または次の期間に含まれる日付に絞り込むことができます。指定できる期間は、日、週、月、四半期、および年です。 したがって、期間に day を指定して previous というフィルター タイプを使用すると、「yesterday」というフィルターが作成されます。あるいは、期間に year を指定して current というフィルター タイプを使用すると、「this year」というフィルターが作成されます。ただし、こうしたフィルターは、フィルターの作成日を基準日としてデータを評価します。したがって、1999 年に作成された「this year」というフィルターを使用すると、たとえ 2012 年にワークブックを開いたとしても、1999 年の日付を含むセルがすべて表示されることになります。

  • applyTopOrBottomFilter

    .applyTopOrBottomFilter( relativeColumnIndex:number );

    TopOrBottomFilter に並べ替えられた値リストで上位 10 番目までに入る値を絞り込む列に TopOrBottomFilter を適用します。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • applyTopOrBottomFilter

    .applyTopOrBottomFilter( relativeColumnIndex:number, type:ig.excel.TopOrBottomFilterType, value:number );

    TopOrBottomFilter に並べ替えられた値リストで上位 10 番目までに入る値を絞り込む列に TopOrBottomFilter を適用します。

    • relativeColumnIndex
    • タイプ:number
    • WorksheetFilterSettings.region に相対する 0 から始まる列インデックス。
    • type
    • タイプ:ig.excel.TopOrBottomFilterType
    • このフィルターのタイプ。
    • value
    • タイプ:number
    • 表示する値の数またはパーセンテージ。

    例外

    例外 説明
    ig.excel.InvalidEnumArgumentException
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
  • applyYearToDateFilter

    .applyYearToDateFilter( relativeColumnIndex:number );

    列に YearToDateFilter を適用します。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • clearFilter

    .clearFilter( relativeColumnIndex:number );

    指定された列に適用されるフィルターをクリアします。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • clearFilters

    .clearFilters( );

    すべての適用されるフィルターをクリアします。

  • clearRegion

    .clearRegion( );

    領域および既存のフィルターおよび並べ替え条件をクリアします。

  • getFilter

    .getFilter( relativeColumnIndex:number );
    返却型:
    ig.excel.Filter
    返却型の説明:
    適用されたフィルター。この列にフィルターが適用されていない場合は null。

    指定された列に適用されるフィルターを取得します。

    例外

    例外 説明
    ig.InvalidOperationException WorksheetFilterSettings.region が設定されない場合。
    ig.ArgumentOutOfRangeException relativeColumnIndex が WorksheetFilterSettings.region 以外かどうか。
  • reapplyFilters

    .reapplyFilters( );

    適用されるフィルターに基づいてフィルター領域のすべてのデータ セルにフィルターを再適用します。

    備考

    フィルターは、領域のデータの変更に伴って絶えず評価しなおされるというわけではありません。フィルターが領域に適用されるのは、並べ替え条件が追加または削除されたときや、ReapplyFilters メソッドが呼び出されたときだけです。

    フィルターが適用されていない場合、このメソッドは列データに対して何も行いません。

    注: フィルターを評価しなおした場合、テーブル列のフィルター条件を満たしていないセルがあると、そうしたセルの行は表示されなくなります。フィルターでふるい落とされた行があると、その行全体がワークシートから隠されてしまうため、同じ行のデータは、テーブルの外側にあっても表示されなくなります。

  • reapplySortConditions

    .reapplySortConditions( );

    並べ替え条件に基づいて領域のすべてのデータ セルに並べ替えを再適用します。

  • region

    .region( );

    フィルター ヘッダーを含む領域全体を返します (読み取り専用)。

  • setRegion

    .setRegion( address:string );

    フィルター設定に適用する領域を設定します。

    • address
    • タイプ:string
    • 新しい領域のアドレス。

    例外

    例外 説明
    ig.InvalidOperationException 領域がテーブルまたはワークシートのその他の予約領域と交差するかどうか。

    備考

    ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。

    注: 領域の設定は適用されるフィルターまたは並べ替え条件をクリアします。

  • setRegion

    .setRegion( address:string, cellReferenceMode:ig.excel.CellReferenceMode );

    フィルター設定に適用する領域を設定します。

    • address
    • タイプ:string
    • 新しい領域のアドレス。
    • cellReferenceMode
    • タイプ:ig.excel.CellReferenceMode
    • アドレスを解析する時に使用される参照。

    例外

    例外 説明
    ig.InvalidOperationException 領域がテーブルまたはワークシートのその他の予約領域と交差するかどうか。

    備考

    ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。

    注: 領域の設定は適用されるフィルターまたは並べ替え条件をクリアします。

  • sortAndFilterAreaRegion

    .sortAndFilterAreaRegion( );

    フィルターおよび並べ替え設定が適用される領域を返します (読み取り専用)。

  • sortSettings

    .sortSettings( );

    ワークシートのフィルター領域内のデータの並べ替え方式を決定する設定値を取得します。

    備考

    注: 並べ替え条件は、領域のデータの変更に伴って絶えず評価し直されるというわけではありません。並べ替え条件が領域に適用されるのは、並べ替え条件が追加または削除されたときや、WorksheetFilterSettings.reapplySortConditions メソッドが呼び出されたときだけです。

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.