pyosbxl.FormatConditions

class documentation

class FormatConditions:

条件付き書式を扱うクラスです。ワークシートから使用します。

osbxlでは、各種条件(複数可)を設定後、apply()メソッドを呼び計算を反映させる必要があります。apply()メソッドの呼び出しを忘れないでください。

Method	`apply`	条件付き書式の適用を行います。
Method	`getAboveAverageCondition`	AboveAverageCondition(平均値より上位/下位による条件付き書式)を取得します。
Method	`getAppliedBordersObject`	セル範囲の設定された条件付き書式の枠線の書式(一括)を取得します。
Method	`getAppliedDataBar`	セル範囲の設定された条件付き書式のデータバーが含まれているかを取得します。
Method	`getAppliedFillObject`	セル範囲の設定された条件付き書式の塗りつぶし書式を取得します。
Method	`getAppliedFontObject`	セル範囲の設定された条件付き書式のフォント書式を取得します。
Method	`getAppliedIconSetObject`	セル範囲の設定された条件付き書式のアイコンセットの書式を取得します。
Method	`getAppliedNumberFormat`	セル範囲の設定された条件付き書式のセル表示書式を取得します。
Method	`getCellValueCondition`	CellValueCondition(セル値による条件付き書式)を取得します。
Method	`getCellValueRangeCondition`	CellValueRangeCondition(セル値範囲による条件付き書式)を取得します。
Method	`getColorScaleFormatCondition`	ColorScaleCondition(グラデーション色による条件付き書式)を取得します。
Method	`getConditionTypes`	全条件付き書式の条件タイプ(どの種類を用いた条件付き書式なのか)を取得します。
Method	`getDataBarFormatCondition`	DataBarCondition(データバーによる条件付き書式)を取得します。
Method	`getIconsetFormatCondition`	IconsetCondition(アイコンセットによる条件付き書式)を取得します。
Method	`getTop10FormatCondition`	Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を取得します。
Method	`getUniqueValuesFormatCondition`	UniqueValueCondition(ユニーク値による条件付き書式)を取得します。
Method	`removeAllCondition`	条件付き書式の条件の全削除を行います。
Method	`removeCondition`	条件付き書式の条件の個別削除を行います。
Method	`setAboveAverageCondition`	AboveAverageCondition(平均値より上位による条件付き書式)を設定します。
Method	`setCellValueCondition`	CellValueCondition(セル値による条件付き書式)を設定します。
Method	`setCellValueRangeCondition`	CellValueRangeCondition(セル値範囲による条件付き書式)を設定します。
Method	`setColorScaleFormatCondition`	ColorScaleCondition(グラデーション色による条件付き書式)を設定します。
Method	`setDataBarFormatCondition`	DataBarCondition(データバーによる条件付き書式)を設定します。
Method	`setIconsetFormatCondition`	IconsetCondition(アイコンセットによる条件付き書式)を設定します。
Method	`setTop10FormatCondition`	Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を設定します。
Method	`setUniqueValuesFormatCondition`	UniqueValueCondition(ユニーク値による条件付き書式)を設定します。

def apply(self): ¶

条件付き書式の適用を行います。

設定したFormatConditionsの適用を行います。このメソッドは全条件設定後に、必ず、呼び出す必要があります。

def getAboveAverageCondition(self, priority: int) -> dto.AboveAverageObject: ¶

AboveAverageCondition(平均値より上位/下位による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`AboveAverageObject`	条件付き書式平均値上位オブジェクト

def getAppliedBordersObject(self, A1C1: str) -> dto.MapStringBordersObject: ¶

セル範囲の設定された条件付き書式の枠線の書式(一括)を取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringBordersObject`	Map＜適用されているセル範囲(A1),枠線の書式(一括)オブジェクト＞

def getAppliedDataBar(self, A1C1: str) -> dto.MapStringBool: ¶

セル範囲の設定された条件付き書式のデータバーが含まれているかを取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringBool`	Map＜適用されているセル範囲(A1),データバーが含まれているかどうか(true:含まれている)＞

def getAppliedFillObject(self, A1C1: str) -> dto.MapStringFillObject: ¶

セル範囲の設定された条件付き書式の塗りつぶし書式を取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringFillObject`	Map＜適用されているセル範囲(A1),塗りつぶしオブジェクト＞

def getAppliedFontObject(self, A1C1: str) -> dto.MapStringFontObject: ¶

セル範囲の設定された条件付き書式のフォント書式を取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringFontObject`	Map＜適用されているセル範囲(A1),フォントオブジェクト＞

def getAppliedIconSetObject(self, A1C1: str) -> dto.MapStringFilterIconsetObject: ¶

セル範囲の設定された条件付き書式のアイコンセットの書式を取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringFilterIconsetObject`	Map＜適用されているセル範囲(A1),アイコンセットオブジェクト＞

def getAppliedNumberFormat(self, A1C1: str) -> dto.MapStringString: ¶

セル範囲の設定された条件付き書式のセル表示書式を取得します。

条件付き書式が適用されているセルのみを返却します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`MapStringString`	Map＜適用されているセル範囲(A1),セル表示書式＞

def getCellValueCondition(self, priority: int) -> dto.CellValueObject: ¶

CellValueCondition(セル値による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`CellValueObject`	条件付き書式セル値オブジェクト

def getCellValueRangeCondition(self, priority: int) -> dto.CellValueRangeObject: ¶

CellValueRangeCondition(セル値範囲による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`CellValueRangeObject`	条件付き書式セル値範囲オブジェクト

def getColorScaleFormatCondition(self, priority: int) -> dto.ColorScaleObject: ¶

ColorScaleCondition(グラデーション色による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`ColorScaleObject`	条件付き書式グラデーション色オブジェクト

def getConditionTypes(self) -> dto.MapIntMapStringXlFormatConditionType: ¶

全条件付き書式の条件タイプ(どの種類を用いた条件付き書式なのか)を取得します。

osbxlでは、priorityは、シート単位で一意に設定します(1から始まります。)。

Returns
`MapIntMapStringXlFormatConditionType`	Map＜プライオリティ(適用順序、値が低いほど先に適用する), Map＜セル範囲,条件付き書式の条件タイプ＞＞

def getDataBarFormatCondition(self, priority: int) -> dto.DataBarObject: ¶

DataBarCondition(データバーによる条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`DataBarObject`	条件付き書式データバーオブジェクト

def getIconsetFormatCondition(self, priority: int) -> dto.IconsetConditionObject: ¶

IconsetCondition(アイコンセットによる条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`IconsetConditionObject`	条件付き書式アイコンセットオブジェクト

def getTop10FormatCondition(self, priority: int) -> dto.Top10Object: ¶

Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`Top10Object`	条件付き書式上位下位オブジェクト

def getUniqueValuesFormatCondition(self, priority: int) -> dto.UniqueValuesObject: ¶

UniqueValueCondition(ユニーク値による条件付き書式)を取得します。

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、Exceptionとなります。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
Returns
`UniqueValuesObject`	条件付き書式ユニーク値オブジェクト

def removeAllCondition(self): ¶

条件付き書式の条件の全削除を行います。

def removeCondition(self, priority: int): ¶

条件付き書式の条件の個別削除を行います。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)

def setAboveAverageCondition(self, priority: int, condition: dto.AboveAverageObject): ¶

AboveAverageCondition(平均値より上位による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`AboveAverageObject`	条件付き書式平均値上位オブジェクト

def setCellValueCondition(self, priority: int, condition: dto.CellValueObject): ¶

CellValueCondition(セル値による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`CellValueObject`	条件付き書式セル値オブジェクト

def setCellValueRangeCondition(self, priority: int, condition: dto.CellValueRangeObject): ¶

CellValueRangeCondition(セル値範囲による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`CellValueRangeObject`	条件付き書式セル値範囲オブジェクト

def setColorScaleFormatCondition(self, priority: int, condition: dto.ColorScaleObject): ¶

ColorScaleCondition(グラデーション色による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`ColorScaleObject`	条件付き書式グラデーション色オブジェクト

def setDataBarFormatCondition(self, priority: int, condition: dto.DataBarObject): ¶

DataBarCondition(データバーによる条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`DataBarObject`	条件付き書式データバーオブジェクト

def setIconsetFormatCondition(self, priority: int, condition: dto.IconsetConditionObject): ¶

IconsetCondition(アイコンセットによる条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`IconsetConditionObject`	条件付き書式アイコンセットオブジェクト

def setTop10FormatCondition(self, priority: int, condition: dto.Top10Object): ¶

Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`Top10Object`	条件付き書式上位下位オブジェクト

def setUniqueValuesFormatCondition(self, priority: int, condition: dto.UniqueValuesObject): ¶

UniqueValueCondition(ユニーク値による条件付き書式)を設定します。

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Parameters
priority:`int`	プライオリティ(適用順序、値が低いほど先に適用する)
condition:`UniqueValuesObject`	条件付き書式ユニーク値オブジェクト