pyosbxl.dto.ColorScaleObject

class documentation

class ColorScaleObject(FormatCondtionBaseObject):

ColorScaleCondition(グラデーション色による条件付き書式)を扱うオブジェクトです。

セル値が数値のセルのみがカラースケールの設定対象となります。

Method	`__init__`	コンストラクタ。インスタンスを作成します。
Method	`getMaximumColor`	評価条件(最大値)のカラースケールの基準値を取得します。
Method	`getMaximumValue`	評価条件(最大値)の閾値を取得します。
Method	`getMaximumValueType`	評価条件(最大値)の評価条件種類を取得します。
Method	`getMediumColor`	評価条件(中間値)のカラースケールの基準値を取得します。
Method	`getMediumValue`	評価条件(中間値)の閾値を取得します。
Method	`getMediumValueType`	評価条件(中間値)の評価条件種類を取得します。
Method	`getMinimumColor`	評価条件(最小値)のカラースケールの基準値を取得します。
Method	`getMinimumValue`	評価条件(最小値)の閾値を取得します。
Method	`getMinimumValueType`	評価条件(最小値)の評価条件種類を取得します。
Method	`setMaximumCondition`	最大値を設定します。
Method	`setMediumCondition`	中間値(3色スケール)を設定します。
Method	`setMinimumCondition`	最小値を設定します。

Method	`getA1C1`	設定されている適用セル範囲を取得します。
Method	`getStopIfTrue`	現在のルールが適用された場合、そのセルの書式ルールをさらに評価するかどうかを取得します。
Method	`setA1C1`	適用セル範囲を設定します。
Method	`setStopIfTrue`	現在のルールが適用された場合、そのセルの書式ルールをさらに評価するかどうかを設定します。

def __init__(self): ¶

overrides pyosbxl.dto.FormatCondtionBaseObject.__init__

コンストラクタ。インスタンスを作成します。

def getMaximumColor(self) -> ColorObject: ¶

評価条件(最大値)のカラースケールの基準値を取得します。

Returns
`ColorObject`	評価条件(最大値)のカラースケールの基準値

def getMaximumValue(self) -> float: ¶

評価条件(最大値)の閾値を取得します。

Returns
`float`	評価条件(最大値)の閾値

def getMaximumValueType(self) -> enums.XlConditionValueType: ¶

評価条件(最大値)の評価条件種類を取得します。

Returns
`XlConditionValueType`	評価条件(最大値)の評価条件種類

def getMediumColor(self) -> ColorObject: ¶

評価条件(中間値)のカラースケールの基準値を取得します。

Returns
`ColorObject`	評価条件(中間値)のカラースケールの基準値

def getMediumValue(self) -> float: ¶

評価条件(中間値)の閾値を取得します。

Returns
`float`	評価条件(中間値)の閾値

def getMediumValueType(self) -> enums.XlConditionValueType: ¶

評価条件(中間値)の評価条件種類を取得します。

Returns
`XlConditionValueType`	評価条件(中間値)の評価条件種類

def getMinimumColor(self) -> ColorObject: ¶

評価条件(最小値)のカラースケールの基準値を取得します。

Returns
`ColorObject`	評価条件(最小値)のカラースケールの基準値

def getMinimumValue(self) -> float: ¶

評価条件(最小値)の閾値を取得します。

Returns
`float`	評価条件(最小値)の閾値

def getMinimumValueType(self) -> enums.XlConditionValueType: ¶

評価条件(最小値)の評価条件種類を取得します。

Returns
`XlConditionValueType`	評価条件(最小値)の評価条件種類

def setMaximumCondition(self, color: ColorObject, type: enums.XlConditionValueType, val: float = -1.0): ¶

最大値を設定します。

def setMediumCondition(self, color: ColorObject, type: enums.XlConditionValueType, val: float = -1.0): ¶

中間値(3色スケール)を設定します。

def setMinimumCondition(self, color: ColorObject, type: enums.XlConditionValueType, val: float = -1.0): ¶

最小値を設定します。