pyosbxl.Color

class documentation

class Color:

View In Hierarchy

色を扱うクラスです。

Method clearColor セル範囲に対して、色のクリアを行います(ワークシート初期値に戻します)。
Method getColorIndex セル範囲の(Excelで定義されている)インデックス色を取得します。
Method getHexColor セル範囲の16進値(RGB)を取得します。
Method getObject セル範囲の水平方向のセル配置位置を取得します。
Method getThemeColor セル範囲のテーマ色の設定色を取得します。
Method getTintAndShade セル範囲の背景の明るさを取得します。
Method setColorIndex セル範囲に対して、インデックス色を設定します。
Method setHexColor セル範囲に対して、16進値(RGB)を適用します。
Method setObject セル範囲に対して、色オブジェクトを適用します。
Method setThemeColor セル範囲に対して、テーマ色とセルの明るさを同時に設定します。
Method setTintAndShade セル範囲に対して、テーマ色を設定します。
def clearColor(self):

セル範囲に対して、色のクリアを行います(ワークシート初期値に戻します)。

def getColorIndex(self) -> dto.MapStringXlIndexColor:

セル範囲の(Excelで定義されている)インデックス色を取得します。

Returns
MapStringXlIndexColorMap＜セル範囲(A1), インデックス色＞
def getHexColor(self) -> dto.MapStringString:

セル範囲の16進値(RGB)を取得します。

Returns
MapStringStringMap＜セル範囲(A1), インデックス色＞
def getObject(self) -> dto.MapStringColorObject:

セル範囲の水平方向のセル配置位置を取得します。

Returns
MapStringColorObjectMap＜セル範囲(A1C1),色オブジェクト＞
def getThemeColor(self) -> dto.MapStringXlThemeColor:

セル範囲のテーマ色の設定色を取得します。

Returns
MapStringXlThemeColorMap＜セル範囲(A1), テーマ色の設定色＞
def getTintAndShade(self) -> dto.MapStringDouble:

セル範囲の背景の明るさを取得します。

Returns
MapStringDoubleMap＜セル範囲(A1), 背景の明るさ(-1.0～1.0)＞
def setColorIndex(self, indexColor: enums.XlIndexColor):

セル範囲に対して、インデックス色を設定します。

Parameters
indexColor:XlIndexColorインデックス色
def setHexColor(self, hexColor: str):

セル範囲に対して、16進値(RGB)を適用します。

Parameters
hexColor:str16進値(RGB)
def setObject(self, colorObject: dto.ColorObject):

セル範囲に対して、色オブジェクトを適用します。

Parameters
colorObject:ColorObject色オブジェクト
def setThemeColor(self, color: enums.XlThemeColor, tintAndShade: float = 0.0):

セル範囲に対して、テーマ色とセルの明るさを同時に設定します。

Parameters
color:XlThemeColorテーマ色
tintAndShade:float, optional明るさ(-1.0～1.0)
def setTintAndShade(self, tintAndShade: float):

セル範囲に対して、テーマ色を設定します。

Parameters
tintAndShade:floatテーマ色