openpyxl.drawing.colors module

class openpyxl.drawing.colors.ColorChoice(scrgbClr=None, srgbClr=None, hslClr=None, sysClr=None, schemeClr=None, prstClr=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

RGB

Aliases can be used when either the desired attribute name is not allowed or confusing in Python (eg. “type”) or a more descriptive name is desired (eg. “underline” for “u”)

RGBPercent

Aliases can be used when either the desired attribute name is not allowed or confusing in Python (eg. “type”) or a more descriptive name is desired (eg. “underline” for “u”)

hslClr

Values must be of type <class ‘openpyxl.drawing.colors.HSLColor’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

prstClr

Value must be one of {‘mediumAquamarine’, ‘beige’, ‘ltBlue’, ‘moccasin’, ‘grey’, ‘dkCyan’, ‘lightGreen’, ‘darkCyan’, ‘dkOliveGreen’, ‘floralWhite’, ‘dkTurquoise’, ‘fuchsia’, ‘deepSkyBlue’, ‘lightSlateGray’, ‘ltYellow’, ‘seaGreen’, ‘azure’, ‘lightCoral’, ‘chocolate’, ‘lightGrey’, ‘turquoise’, ‘rosyBrown’, ‘medAquamarine’, ‘ltGreen’, ‘linen’, ‘lightSkyBlue’, ‘lightYellow’, ‘crimson’, ‘ltSlateGrey’, ‘dkSeaGreen’, ‘saddleBrown’, ‘darkGreen’, ‘dkKhaki’, ‘tomato’, ‘medVioletRed’, ‘deepPink’, ‘magenta’, ‘ltPink’, ‘burlyWood’, ‘firebrick’, ‘gold’, ‘tan’, ‘lightGoldenrodYellow’, ‘darkGrey’, ‘silver’, ‘papayaWhip’, ‘steelBlue’, ‘ltCoral’, ‘dkGreen’, ‘medPurple’, ‘dkGrey’, ‘mediumSlateBlue’, ‘mistyRose’, ‘dkOrchid’, ‘ghostWhite’, ‘orange’, ‘orchid’, ‘darkTurquoise’, ‘white’, ‘cornflowerBlue’, ‘ltSeaGreen’, ‘paleTurquoise’, ‘darkSlateBlue’, ‘indigo’, ‘maroon’, ‘mediumSpringGreen’, ‘medBlue’, ‘midnightBlue’, ‘hotPink’, ‘dkViolet’, ‘lightPink’, ‘green’, ‘seaShell’, ‘darkGray’, ‘lightSteelBlue’, ‘lightBlue’, ‘ltGray’, ‘cadetBlue’, ‘red’, ‘darkSeaGreen’, ‘ltGoldenrodYellow’, ‘ltSteelBlue’, ‘mediumVioletRed’, ‘snow’, ‘gainsboro’, ‘teal’, ‘olive’, ‘mediumOrchid’, ‘dkGoldenrod’, ‘darkKhaki’, ‘ivory’, ‘paleGoldenrod’, ‘darkOrchid’, ‘oldLace’, ‘lightCyan’, ‘cornsilk’, ‘peru’, ‘darkRed’, ‘lemonChiffon’, ‘lavender’, ‘darkSlateGrey’, ‘darkGoldenrod’, ‘springGreen’, ‘oliveDrab’, ‘violet’, ‘sienna’, ‘darkOrange’, ‘dkGray’, ‘plum’, ‘darkBlue’, ‘dkBlue’, ‘medSeaGreen’, ‘ltSlateGray’, ‘khaki’, ‘ltCyan’, ‘sandyBrown’, ‘lightSlateGrey’, ‘yellow’, ‘blueViolet’, ‘coral’, ‘ltGrey’, ‘indianRed’, ‘lavenderBlush’, ‘honeydew’, ‘aquamarine’, ‘wheat’, ‘aqua’, ‘darkSlateGray’, ‘goldenrod’, ‘mediumTurquoise’, ‘pink’, ‘whiteSmoke’, ‘forestGreen’, ‘skyBlue’, ‘slateBlue’, ‘darkOliveGreen’, ‘darkSalmon’, ‘bisque’, ‘peachPuff’, ‘dkMagenta’, ‘ltSalmon’, ‘brown’, ‘lime’, ‘dkSalmon’, ‘gray’, ‘slateGray’, ‘mediumSeaGreen’, ‘medSpringGreen’, ‘cyan’, ‘mintCream’, ‘blanchedAlmond’, ‘medOrchid’, ‘dkOrange’, ‘chartreuse’, ‘powderBlue’, ‘limeGreen’, ‘thistle’, ‘lightSeaGreen’, ‘mediumPurple’, ‘dkSlateGray’, ‘aliceBlue’, ‘slateGrey’, ‘navy’, ‘darkMagenta’, ‘dkSlateGrey’, ‘ltSkyBlue’, ‘orangeRed’, ‘darkViolet’, ‘greenYellow’, ‘medSlateBlue’, ‘dimGray’, ‘paleGreen’, ‘royalBlue’, ‘black’, ‘blue’, ‘dimGrey’, ‘navajoWhite’, ‘dkSlateBlue’, ‘yellowGreen’, ‘dodgerBlue’, ‘lightGray’, ‘lawnGreen’, ‘lightSalmon’, ‘antiqueWhite’, ‘salmon’, ‘paleVioletRed’, ‘purple’, ‘mediumBlue’, ‘dkRed’, ‘medTurquoise’}

schemeClr

Values must be of type <class ‘openpyxl.drawing.colors.SchemeColor’>

scrgbClr

Values must be of type <class ‘openpyxl.drawing.colors.RGBPercent’>

srgbClr

Values must be of type <class ‘str’>

sysClr

Values must be of type <class ‘openpyxl.drawing.colors.SystemColor’>

tagname = 'colorChoice'

class openpyxl.drawing.colors.ColorChoiceDescriptor(*args, **kw)

Bases: openpyxl.descriptors.base.Typed

Objects can choose from 7 different kinds of color system. Assume RGBHex if a string is passed in.

allow_none = True

expected_type

alias of ColorChoice

class openpyxl.drawing.colors.ColorMapping(bg1='lt1', tx1='dk1', bg2='lt2', tx2='dk2', accent1='accent1', accent2='accent2', accent3='accent3', accent4='accent4', accent5='accent5', accent6='accent6', hlink='hlink', folHlink='folHlink', extLst=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

accent1

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

accent2

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

accent3

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

accent4

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

accent5

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

accent6

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

bg1

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

bg2

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

folHlink

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

hlink

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

tagname = 'clrMapOvr'

tx1

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

tx2

Value must be one of {‘accent1’, ‘lt1’, ‘accent5’, ‘dk2’, ‘accent3’, ‘hlink’, ‘accent4’, ‘dk1’, ‘accent6’, ‘lt2’, ‘accent2’, ‘folHlink’}

class openpyxl.drawing.colors.HSLColor(hue=None, sat=None, lum=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

hue

Values must be of type <class ‘int’>

lum

Values must be of type <class ‘float’>

sat

Values must be of type <class ‘float’>

tagname = 'hslClr'

class openpyxl.drawing.colors.RGBPercent(r=None, g=None, b=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

b

Values must be of type <class ‘float’>

g

Values must be of type <class ‘float’>

r

Values must be of type <class ‘float’>

tagname = 'rgbClr'

class openpyxl.drawing.colors.SchemeColor(tint=None, shade=None, comp=None, inv=None, gray=None, alpha=None, alphaOff=None, alphaMod=None, hue=None, hueOff=None, hueMod=None, sat=None, satOff=None, satMod=None, lum=None, lumOff=None, lumMod=None, red=None, redOff=None, redMod=None, green=None, greenOff=None, greenMod=None, blue=None, blueOff=None, blueMod=None, gamma=None, invGamma=None, val=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

alpha

Values must be of type <class ‘int’>

alphaMod

Values must be of type <class ‘int’>

alphaOff

Values must be of type <class ‘int’>

blue

Values must be of type <class ‘int’>

blueMod

Values must be of type <class ‘int’>

blueOff

Values must be of type <class ‘int’>

comp

Values must be of type <class ‘bool’>

gamma

Values must be of type <class ‘bool’>

gray

Values must be of type <class ‘int’>

green

Values must be of type <class ‘int’>

greenMod

Values must be of type <class ‘int’>

greenOff

Values must be of type <class ‘int’>

hue

Values must be of type <class ‘int’>

hueMod

Values must be of type <class ‘int’>

hueOff

Values must be of type <class ‘int’>

inv

Values must be of type <class ‘int’>

invGamma

Values must be of type <class ‘bool’>

lum

Values must be of type <class ‘int’>

lumMod

Values must be of type <class ‘int’>

lumOff

Values must be of type <class ‘int’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

red

Values must be of type <class ‘int’>

redMod

Values must be of type <class ‘int’>

redOff

Values must be of type <class ‘int’>

sat

Values must be of type <class ‘int’>

satMod

Values must be of type <class ‘int’>

satOff

Values must be of type <class ‘int’>

shade

Values must be of type <class ‘int’>

tagname = 'schemeClr'

tint

Values must be of type <class ‘int’>

val

Value must be one of {‘accent1’, ‘phClr’, ‘accent5’, ‘bg2’, ‘lt1’, ‘dk2’, ‘accent3’, ‘lt2’, ‘hlink’, ‘bg1’, ‘accent4’, ‘dk1’, ‘accent6’, ‘tx1’, ‘tx2’, ‘accent2’, ‘folHlink’}

class openpyxl.drawing.colors.SystemColor(val='windowText', lastClr=None, tint=None, shade=None, comp=None, inv=None, gray=None, alpha=None, alphaOff=None, alphaMod=None, hue=None, hueOff=None, hueMod=None, sat=None, satOff=None, satMod=None, lum=None, lumOff=None, lumMod=None, red=None, redOff=None, redMod=None, green=None, greenOff=None, greenMod=None, blue=None, blueOff=None, blueMod=None, gamma=None, invGamma=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

alpha

Values must be of type <class ‘int’>

alphaMod

Values must be of type <class ‘int’>

alphaOff

Values must be of type <class ‘int’>

blue

Values must be of type <class ‘int’>

blueMod

Values must be of type <class ‘int’>

blueOff

Values must be of type <class ‘int’>

comp

Values must be of type <class ‘openpyxl.drawing.colors.Transform’>

gamma

Values must be of type <class ‘openpyxl.drawing.colors.Transform’>

gray

Values must be of type <class ‘openpyxl.drawing.colors.Transform’>

green

Values must be of type <class ‘int’>

greenMod

Values must be of type <class ‘int’>

greenOff

Values must be of type <class ‘int’>

hue

Values must be of type <class ‘int’>

hueMod

Values must be of type <class ‘int’>

hueOff

Values must be of type <class ‘int’>

inv

Values must be of type <class ‘openpyxl.drawing.colors.Transform’>

invGamma

Values must be of type <class ‘openpyxl.drawing.colors.Transform’>

lastClr

Values must be of type <class ‘str’>

lum

Values must be of type <class ‘int’>

lumMod

Values must be of type <class ‘int’>

lumOff

Values must be of type <class ‘int’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

red

Values must be of type <class ‘int’>

redMod

Values must be of type <class ‘int’>

redOff

Values must be of type <class ‘int’>

sat

Values must be of type <class ‘int’>

satMod

Values must be of type <class ‘int’>

satOff

Values must be of type <class ‘int’>

shade

Values must be of type <class ‘int’>

tagname = 'sysClr'

tint

Values must be of type <class ‘int’>

val

Value must be one of {‘btnHighlight’, ‘gradientInactiveCaption’, ‘appWorkspace’, ‘inactiveCaptionText’, ‘window’, ‘background’, ‘activeBorder’, ‘inactiveBorder’, ‘hotLight’, ‘menuBar’, ‘infoText’, ‘menuHighlight’, ‘inactiveCaption’, ‘menuText’, ‘btnShadow’, ‘scrollBar’, ‘btnFace’, ‘3dDkShadow’, ‘infoBk’, ‘highlight’, ‘grayText’, ‘highlightText’, ‘activeCaption’, ‘captionText’, ‘windowFrame’, ‘btnText’, ‘gradientActiveCaption’, ‘windowText’, ‘3dLight’, ‘menu’}

class openpyxl.drawing.colors.Transform

Bases: openpyxl.descriptors.serialisable.Serialisable