pyosbxl.AutoFilter

class documentation

class AutoFilter:

View In Hierarchy

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

Method getAddress オートフィルターの対象セル範囲を取得します。
Method getSort 並び替えクラスを取得します。
Method removeFilter オートフィルターの削除を行います。オートフィルター自体を削除します。
Method resetAllFilter オートフィルター条件の全クリアを行います。オートフィルター自体は残ります。
Method resetFilter オートフィルター条件のクリアを行います。
Method setAndCustomFilter AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合))の設定を行います。
Method setAverageFilter averageFilter(平均値によるフィルター)の設定を行います。
Method setBottom10PercentFilter BottomPercentFilter(値の下位のパーセント値フィルター)の設定を行います。
Method setBottom10ValueFilter Bottom10ValueFilter(値の下位の値フィルター)の設定を行います。
Method setCellColorFilter CellColorFilter(セル色によるフィルター)の設定を行います。
Method setCustomFilter CustomFilter(ワイルドカード含む任意条件のフィルター)の設定を行います。
Method setDateTimeFilter DateTimeFilter(表示日時によるフィルター)の設定を行います。
Method setDateTimeGroupingFilter DateTimeGroupingFilter(表示日時(複数)によるフィルター)の設定を行います。
Method setFontColorFilter FontColorFilter(フォント色によるフィルター)の設定を行います。
Method setIconFilter IconFilter(表示アイコンによるフィルター)の設定を行います。
Method setOrCustomFilter OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合))の設定を行います。
Method setTop10PercentFilter Top10PercentFilter(値の上位のパーセント値フィルター)の設定を行います。
Method setTop10ValueFilter Top10ValueFilter(値の上位の値フィルター)の設定を行います。
Method setUniqueValuesDateTimeFilter UniqueValueFilter(値(日付/時刻オブジェクト)の一意性によるフィルター)の設定を行います。
Method setUniqueValuesNumberFilter UniqueValueFilter(値(数値)の一意性によるフィルター)の設定を行います。
Method setUniqueValuesStringFilter UniqueValueFilter(値(文字列)の一意性によるフィルター: 先頭列)の設定を行います。
def getAddress(self) -> str:

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

Returns
str対象セル範囲(A1C1)
def getSort(self) -> Sort:

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

Returns
Sort並び替えクラス
def removeFilter(self):

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

def resetAllFilter(self):

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

def resetFilter(self, colId: int):

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

Parameters
colId:int条件削除対象列 (先頭列=1)
def setAndCustomFilter(self, op1: enums.XlAutoFilterOperator, criteria1: str, op2: enums.XlAutoFilterOperator, criteria2: str, colId: int = 1):

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

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

Parameters
op1:XlAutoFilterOperator演算子
criteria1:str検索条件1
op2:XlAutoFilterOperator演算子
criteria2:str検索条件2
colId:int, optionalフィルター対象列 (先頭列=1)
def setAverageFilter(self, aboveAverage: bool, colId: int = 1):

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

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

Parameters
aboveAverage:booltrue: 平均値以上 false: 平均値以下
colId:int, optionalフィルター対象列 (先頭列=1)
def setBottom10PercentFilter(self, filterVal: int, colId: int = 1):

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

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

Parameters
filterVal:intフィルター値(パーセント値: 0～100)
colId:int, optionalフィルター対象列 (先頭列=1)
def setBottom10ValueFilter(self, filterVal: int, colId: int = 1):

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

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

Parameters
filterVal:intフィルター値
colId:int, optionalフィルター対象列 (先頭列=1)
def setCellColorFilter(self, targetA1: str, colId: int = 1):

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

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

Parameters
targetA1:str対象セル
colId:int, optionalフィルター対象列 (先頭列=1)
def setCustomFilter(self, op: enums.XlAutoFilterOperator, criteria: str, colId: int = 1):

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

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

Parameters
op:XlAutoFilterOperator演算子
criteria:str検索条件
colId:int, optionalフィルター対象列 (先頭列=1)
def setDateTimeFilter(self, filterVal: enums.XlAutoFilterDateTime, colId: int = 1):

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

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

Parameters
filterVal:XlAutoFilterDateTime日付のグルーピング単位
colId:int, optionalフィルター対象列 (先頭列=1)
def setDateTimeGroupingFilter(self, filterVals: dto.VectorDateTimeObject, filterTypes: dto.VectorXlDateTimeGroupingType, colId: int = 1):

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

パラメータfilterValsは、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。 パラメータfilterTypesは、複数値設定可能です。グルーピングの単位を指定します。 パラメータfilterValsの数とパラメータfilterTypesの数は、同じである必要があります。n番目のfilterValsの値をn番目のfilterTypesの条件でフィルター条件とします。

Parameters
filterVals:VectorDateTimeObjectList＜フィルター対象日付/時刻オブジェクト＞
filterTypes:VectorXlDateTimeGroupingTypeList＜グルーピング単位＞
colId:int, optionalフィルター対象列 (先頭列=1)
def setFontColorFilter(self, targetA1: str, colId: int = 1):

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

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

Parameters
targetA1:str対象セル
colId:int, optionalフィルター対象列 (先頭列=1)
def setIconFilter(self, filterIconset: enums.XlFilterIconSet, filterIconId: int, colId: int = 1):

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

Parameters
filterIconset:XlFilterIconSetアイコンセット。アイコンセットなしに設定する場合は、XlFilterIconSet.IconSetNoneを設定します。
filterIconId:intアイコンセットの中のアイコンID 1から始まります。アイコンセットなしに設定する場合は任意の値となります。
colId:int, optionalフィルター対象列 (先頭列=1)
def setOrCustomFilter(self, op1: enums.XlAutoFilterOperator, criteria1: str, op2: enums.XlAutoFilterOperator, criteria2: str, colId: int = 1):

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

Parameters
op1:XlAutoFilterOperator演算子
criteria1:str検索条件1
op2:XlAutoFilterOperator演算子
criteria2:str検索条件2
colId:int, optionalフィルター対象列 (先頭列=1)
def setTop10PercentFilter(self, filterVal: int, colId: int = 1):

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

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

Parameters
filterVal:intフィルター値(パーセント値: 0～100)
colId:int, optionalフィルター対象列 (先頭列=1)
def setTop10ValueFilter(self, filterVal: int, colId: int = 1):

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

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

Parameters
filterVal:intフィルター値
colId:int, optionalフィルター対象列 (先頭列=1)
def setUniqueValuesDateTimeFilter(self, filterVals: dto.VectorDateTimeObject, colId: int = 1):

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

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

Parameters
filterVals:VectorDateTimeObjectList＜フィルター対象日付/時刻オブジェクト＞
colId:int, optionalフィルター対象列 (先頭列=1)
def setUniqueValuesNumberFilter(self, filterVals: dto.VectorDouble, colId: int = 1):

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

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

Parameters
filterVals:VectorDoubleList＜フィルター対象数値＞
colId:int, optionalフィルター対象列 (先頭列=1)
def setUniqueValuesStringFilter(self, filterVals: dto.VectorString, colId: int = 1):

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

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

Parameters
filterVals:VectorStringList＜フィルター対象文字列＞
colId:int, optionalフィルター対象列 (先頭列=1)