Class: RubyOSBXL::AutoFilter

Inherits:

Object

• Object
• RubyOSBXL::AutoFilter

Defined in:

lib/rubyosbxl.rb

Overview

オートフィルターを扱うクラスです。ワークシートまたは、テーブルから使用します。

Instance Method Summary

• #getAddress ⇒ String

  オートフィルターの対象セル範囲を取得します。.

• #getSort ⇒ RubyOSBXL::Sort

  並び替えクラスを取得します。.

• #removeFilter ⇒ void

  オートフィルターの削除を行います。オートフィルター自体を削除します。.

• #resetAllFilter ⇒ void

  オートフィルター条件の全クリアを行います。オートフィルター自体は残ります。.

• #resetFilter(colId) ⇒ void

  オートフィルター条件のクリアを行います。.

• #setAndCustomFilter(op1, criteria1, op2, criteria2, colId = 1) ⇒ void

  AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合))の設定を行います。.

• #setAverageFilter(aboveAverage, colId = 1) ⇒ void

  averageFilter(平均値によるフィルター)の設定を行います。.

• #setBottom10PercentFilter(filterVal, colId = 1) ⇒ void

  BottomPercentFilter(値の下位のパーセント値フィルター)の設定を行います。.

• #setBottom10ValueFilter(filterVal, colId = 1) ⇒ void

  Bottom10ValueFilter(値の下位の値フィルター)の設定を行います。.

• #setCellColorFilter(targetA1, colId = 1) ⇒ void

  CellColorFilter(セル色によるフィルター)の設定を行います。.

• #setCustomFilter(op, criteria, colId = 1) ⇒ void

  CustomFilter(ワイルドカード含む任意条件のフィルター)の設定を行います。.

• #setDateTimeFilter(filterVal, colId = 1) ⇒ void

  DateTimeFilter(表示日時によるフィルター)の設定を行います。.

• #setDateTimeGroupingFilter(filterVals, filterTypes, colId = 1) ⇒ void

  DateTimeGroupingFilter(表示日時(複数)によるフィルター)の設定を行います。.

• #setFontColorFilter(targetA1, colId = 1) ⇒ void

  FontColorFilter(フォント色によるフィルター)の設定を行います。.

• #setIconFilter(filterIconset, filterIconId, colId = 1) ⇒ void

  IconFilter(表示アイコンによるフィルター)の設定を行います。.

• #setOrCustomFilter(op1, criteria1, op2, criteria2, colId = 1) ⇒ void

  OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合))の設定を行います。.

• #setTop10PercentFilter(filterVal, colId = 1) ⇒ void

  Top10PercentFilter(値の上位のパーセント値フィルター)の設定を行います。.

• #setTop10ValueFilter(filterVal, colId = 1) ⇒ void

  Top10ValueFilter(値の上位の値フィルター)の設定を行います。.

• #setUniqueValuesDateTimeFilter(filterVals, colId = 1) ⇒ void

  UniqueValueFilter(値(日時オブジェクト)の一意性によるフィルター)の設定を行います。.

• #setUniqueValuesNumberFilter(filterVals, colId = 1) ⇒ void

  UniqueValueFilter(値(数値)の一意性によるフィルター)の設定を行います。.

• #setUniqueValuesStringFilter(filterVals, colId = 1) ⇒ void

  UniqueValueFilter(値(文字列)の一意性によるフィルター)の設定を行います。.

Instance Method Details

#getAddress ⇒ String

オートフィルターの対象セル範囲を取得します。

Returns:

• (String) —

  対象セル範囲

#getSort ⇒ RubyOSBXL::Sort

並び替えクラスを取得します。

Returns:

• (RubyOSBXL::Sort) —

  並び替えクラス

#removeFilter ⇒ void

オートフィルターの削除を行います。オートフィルター自体を削除します。

#resetAllFilter ⇒ void

オートフィルター条件の全クリアを行います。オートフィルター自体は残ります。

#resetFilter(colId) ⇒ void

オートフィルター条件のクリアを行います。

Parameters:

• colId (Integer) —

  条件削除対象列 (先頭列=1)

#setAndCustomFilter(op1, criteria1, op2, criteria2, colId = 1) ⇒ void

Note:

パラメータcriteria1, パラメータcriteria2には、#, ? 等を含む条件式が入力可能です。(Excelと同一です)

AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合))の設定を行います。

Parameters:

• op1 (RubyOSBXL::Enums::XlAutoFilterOperator) —

  演算子

• criteria1 (String) —

  検索条件1

• op2 (RubyOSBXL::Enums::XlAutoFilterOperator) —

  演算子

• criteria2 (String) —

  検索条件2

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setAverageFilter(aboveAverage, colId = 1) ⇒ void

Note:

パラメータaboveAverageが、trueは、平均以上、falseは、平均以下が、フィルター対象となります。

averageFilter(平均値によるフィルター)の設定を行います。

Parameters:

• aboveAverage (bool) —

  true: 平均値以上 false: 平均値以下

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setBottom10PercentFilter(filterVal, colId = 1) ⇒ void

Note:

下位filterValパーセントがフィルター条件となります。

BottomPercentFilter(値の下位のパーセント値フィルター)の設定を行います。

Parameters:

• filterVal (Numeric) —

  フィルター値(パーセント値: 0.0～1.000)

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setBottom10ValueFilter(filterVal, colId = 1) ⇒ void

Note:

下位filterVal件がフィルター条件となります。

Bottom10ValueFilter(値の下位の値フィルター)の設定を行います。

Parameters:

• filterVal (Numeric) —

  フィルター値

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setCellColorFilter(targetA1, colId = 1) ⇒ void

Note:

パラメータtargetA1のセルのセル色をフィルター条件に加えます。このパラメータが空値の場合、セル色は、自動となります。

CellColorFilter(セル色によるフィルター)の設定を行います。

Parameters:

• targetA1 (String) —

  対象セル

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setCustomFilter(op, criteria, colId = 1) ⇒ void

Note:

任意条件のフィルターを設定します。パラメータcriteriaには、#, ? 等を含む条件式が入力可能です。(Excelと同一です)

CustomFilter(ワイルドカード含む任意条件のフィルター)の設定を行います。

Parameters:

• op (RubyOSBXL::Enums::XlAutoFilterOperator) —

  演算子

• criteria (String) —

  検索条件

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setDateTimeFilter(filterVal, colId = 1) ⇒ void

Note:

パラメータfilterValの単位をフィルター条件に設定します。

DateTimeFilter(表示日時によるフィルター)の設定を行います。

Parameters:

• filterVal (RubyOSBXL::Enums::XlAutoFilterDateTime) —

  日付のグルーピング単位

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setDateTimeGroupingFilter(filterVals, filterTypes, colId = 1) ⇒ void

Note:

パラメータfilterValsは、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。

Note:

パラメータfilterTypesは、複数値設定可能です。グルーピングの単位を指定します。

Note:

パラメータfilterValsの数とパラメータfilterTypesの数は、同じである必要があります。n番目のfilterValsの値をn番目のfilterTypesの条件でフィルター条件とします。

DateTimeGroupingFilter(表示日時(複数)によるフィルター)の設定を行います。

Parameters:

• filterVals (Array<RubyOSBXL::Dto::DateTimeObject>) —

  Array<フィルター対象日時オブジェクト>

• filterTypes (Array<RubyOSBXL::Enums::XlDateTimeGroupingType>) —

  Array<日時のグルーピング単位>

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setFontColorFilter(targetA1, colId = 1) ⇒ void

Note:

パラメータtargetA1のセルのフォント色をフィルター条件に加えます。このパラメータが空値の場合、フォント色は自動となります。

FontColorFilter(フォント色によるフィルター)の設定を行います。

Parameters:

• targetA1 (String) —

  対象セル

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setIconFilter(filterIconset, filterIconId, colId = 1) ⇒ void

Note:

パラメータfilterIconIdは、パラメータfilterIconset’のアイコンの中で、何番目のアイコンをフィルター対象にするか設定します。

IconFilter(表示アイコンによるフィルター)の設定を行います。

Parameters:

• filterIconset (RubyOSBXL::Enums::XlFilterIconSet) —

  アイコンセット アイコンセットなしに設定する場合は、XlFilterIconSet.IconSetNoneを設定します。

• filterIconId (Integer) —

  アイコンセットの中のアイコンID 1から始まります。アイコンセットなしに設定する場合は任意の値となります。

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setOrCustomFilter(op1, criteria1, op2, criteria2, colId = 1) ⇒ void

Note:

パラメータcriteria1, パラメータcriteria2には、#, ? 等を含む条件式が入力可能です。(Excelと同一です)

OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合))の設定を行います。

Parameters:

• op1 (RubyOSBXL::Enums::XlAutoFilterOperator) —

  演算子

• criteria1 (String) —

  検索条件1

• op2 (RubyOSBXL::Enums::XlAutoFilterOperator) —

  演算子

• criteria2 (String) —

  検索条件2

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setTop10PercentFilter(filterVal, colId = 1) ⇒ void

Note:

上位filterValパーセントがフィルター条件となります。

Top10PercentFilter(値の上位のパーセント値フィルター)の設定を行います。

Parameters:

• filterVal (Numeric) —

  フィルター値(パーセント値: 0.0～1.000)

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setTop10ValueFilter(filterVal, colId = 1) ⇒ void

Note:

上位filterVal件がフィルター条件となります。

Top10ValueFilter(値の上位の値フィルター)の設定を行います。

Parameters:

• filterVal (Numeric) —

  フィルター値

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setUniqueValuesDateTimeFilter(filterVals, colId = 1) ⇒ void

Note:

パラメータfilterValsは、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。

UniqueValueFilter(値(日時オブジェクト)の一意性によるフィルター)の設定を行います。

Parameters:

• filterVals (Array<RubyOSBXL::Dto::DateTimeObject>) —

  Array<フィルター対象日時オブジェクト>

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setUniqueValuesNumberFilter(filterVals, colId = 1) ⇒ void

Note:

パラメータfilterValsは、複数値設定可能です。セルの値が数値であるセルがフィルター対象です。

UniqueValueFilter(値(数値)の一意性によるフィルター)の設定を行います。

Parameters:

• filterVals (Array<Numeric>) —

  Array<フィルター対象数値>

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)

#setUniqueValuesStringFilter(filterVals, colId = 1) ⇒ void

Note:

パラメータfilterValsは、複数値設定可能です。セルの値が文字列であるセルがフィルター対象です。

UniqueValueFilter(値(文字列)の一意性によるフィルター)の設定を行います。

Parameters:

• filterVals (Array<String>) —

  Array<String> フィルター対象文字列

• colId (Integer) (defaults to: 1) —

  フィルター対象列 (先頭列=1)