openpyxl.drawing.fill module¶
-
class
openpyxl.drawing.fill.
Blip
(cstate=None, embed=None, link=None, noGrp=None, noSelect=None, noRot=None, noChangeAspect=None, noMove=None, noResize=None, noEditPoints=None, noAdjustHandles=None, noChangeArrowheads=None, noChangeShapeType=None, extLst=None, alphaBiLevel=None, alphaCeiling=None, alphaFloor=None, alphaInv=None, alphaMod=None, alphaModFix=None, alphaRepl=None, biLevel=None, blur=None, clrChange=None, clrRepl=None, duotone=None, fillOverlay=None, grayscl=None, hsl=None, lum=None, tint=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
alphaBiLevel
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaBiLevelEffect’>
-
alphaCeiling
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaCeilingEffect’>
-
alphaFloor
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaFloorEffect’>
-
alphaInv
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaInverseEffect’>
-
alphaMod
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaModulateEffect’>
-
alphaModFix
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaModulateFixedEffect’>
-
alphaRepl
¶ Values must be of type <class ‘openpyxl.drawing.effect.AlphaReplaceEffect’>
-
biLevel
¶ Values must be of type <class ‘openpyxl.drawing.effect.BiLevelEffect’>
-
blur
¶ Values must be of type <class ‘openpyxl.drawing.effect.BlurEffect’>
-
clrChange
¶ Values must be of type <class ‘openpyxl.drawing.effect.ColorChangeEffect’>
-
clrRepl
¶ Values must be of type <class ‘openpyxl.drawing.effect.ColorReplaceEffect’>
-
cstate
¶ Value must be one of {‘print’, ‘screen’, ‘email’, ‘hqprint’}
-
duotone
¶ Values must be of type <class ‘openpyxl.drawing.effect.DuotoneEffect’>
-
embed
¶ Values must be of type <class ‘str’>
-
extLst
¶ Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>
-
fillOverlay
¶ Values must be of type <class ‘openpyxl.drawing.effect.FillOverlayEffect’>
-
grayscl
¶ Values must be of type <class ‘openpyxl.drawing.effect.GrayscaleEffect’>
-
hsl
¶ Values must be of type <class ‘openpyxl.drawing.effect.HSLEffect’>
-
link
¶ Values must be of type <class ‘str’>
-
lum
¶ Values must be of type <class ‘openpyxl.drawing.effect.LuminanceEffect’>
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
noAdjustHandles
¶ Values must be of type <class ‘bool’>
-
noChangeArrowheads
¶ Values must be of type <class ‘bool’>
-
noChangeAspect
¶ Values must be of type <class ‘bool’>
-
noChangeShapeType
¶ Values must be of type <class ‘bool’>
-
noEditPoints
¶ Values must be of type <class ‘bool’>
-
noGrp
¶ Values must be of type <class ‘bool’>
-
noMove
¶ Values must be of type <class ‘bool’>
-
noResize
¶ Values must be of type <class ‘bool’>
-
noRot
¶ Values must be of type <class ‘bool’>
-
noSelect
¶ Values must be of type <class ‘bool’>
-
tagname
= 'blip'¶
-
tint
¶ Values must be of type <class ‘openpyxl.drawing.effect.TintEffect’>
-
-
class
openpyxl.drawing.fill.
BlipFillProperties
(dpi=None, rotWithShape=None, blip=None, tile=None, stretch=<openpyxl.drawing.fill.StretchInfoProperties object> Parameters: fillRect=<openpyxl.drawing.fill.RelativeRect object> Parameters: l=None, t=None, r=None, b=None, srcRect=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
blip
¶ Values must be of type <class ‘openpyxl.drawing.fill.Blip’>
-
dpi
¶ Values must be of type <class ‘int’>
-
rotWithShape
¶ Values must be of type <class ‘bool’>
-
srcRect
¶ Values must be of type <class ‘openpyxl.drawing.fill.RelativeRect’>
-
stretch
¶ Values must be of type <class ‘openpyxl.drawing.fill.StretchInfoProperties’>
-
tagname
= 'blipFill'¶
-
tile
¶ Values must be of type <class ‘openpyxl.drawing.fill.TileInfoProperties’>
-
-
class
openpyxl.drawing.fill.
GradientFillProperties
(flip=None, rotWithShape=None, gsLst=(), lin=None, path=None, tileRect=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
flip
¶ Value must be one of {‘y’, ‘xy’, ‘x’}
-
gsLst
¶ Wrap a sequence in an containing object
-
lin
¶ Values must be of type <class ‘openpyxl.drawing.fill.LinearShadeProperties’>
-
linear
¶ 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”)
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
path
¶ Values must be of type <class ‘openpyxl.drawing.fill.PathShadeProperties’>
-
rotWithShape
¶ Values must be of type <class ‘bool’>
-
stop_list
¶ 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”)
-
tagname
= 'gradFill'¶
-
tileRect
¶ Values must be of type <class ‘openpyxl.drawing.fill.RelativeRect’>
-
-
class
openpyxl.drawing.fill.
GradientStop
(pos=None, scrgbClr=None, srgbClr=None, hslClr=None, sysClr=None, schemeClr=None, prstClr=None)[source]¶ 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'¶
-
pos
¶ Values must be of type <class ‘float’>
-
prstClr
¶ Value must be one of {‘medTurquoise’, ‘ltSeaGreen’, ‘dkSeaGreen’, ‘dimGrey’, ‘lightSlateGray’, ‘whiteSmoke’, ‘medVioletRed’, ‘dkKhaki’, ‘crimson’, ‘darkGreen’, ‘steelBlue’, ‘lavender’, ‘darkGray’, ‘chartreuse’, ‘tan’, ‘sienna’, ‘dkRed’, ‘orangeRed’, ‘chocolate’, ‘white’, ‘ltBlue’, ‘dkViolet’, ‘teal’, ‘dkOrchid’, ‘dkCyan’, ‘seaShell’, ‘medSpringGreen’, ‘lightGoldenrodYellow’, ‘slateGrey’, ‘darkCyan’, ‘lightGrey’, ‘ltSteelBlue’, ‘silver’, ‘peachPuff’, ‘blanchedAlmond’, ‘plum’, ‘dkOrange’, ‘lightYellow’, ‘lightGray’, ‘darkMagenta’, ‘ltSalmon’, ‘goldenrod’, ‘lemonChiffon’, ‘darkTurquoise’, ‘sandyBrown’, ‘medAquamarine’, ‘dkTurquoise’, ‘lightPink’, ‘ltGrey’, ‘aliceBlue’, ‘mediumSpringGreen’, ‘lightSlateGrey’, ‘mistyRose’, ‘dkSalmon’, ‘darkSalmon’, ‘red’, ‘wheat’, ‘khaki’, ‘mediumSeaGreen’, ‘orange’, ‘brown’, ‘gray’, ‘darkGrey’, ‘honeydew’, ‘lightSkyBlue’, ‘ltCyan’, ‘lavenderBlush’, ‘lawnGreen’, ‘peru’, ‘aquamarine’, ‘mediumVioletRed’, ‘slateBlue’, ‘cornsilk’, ‘lightSteelBlue’, ‘dkSlateBlue’, ‘rosyBrown’, ‘floralWhite’, ‘olive’, ‘oliveDrab’, ‘gold’, ‘dkGreen’, ‘royalBlue’, ‘salmon’, ‘papayaWhip’, ‘dkBlue’, ‘ltSkyBlue’, ‘indigo’, ‘darkSlateGray’, ‘lime’, ‘medPurple’, ‘darkOrange’, ‘cornflowerBlue’, ‘orchid’, ‘paleVioletRed’, ‘lightCoral’, ‘azure’, ‘coral’, ‘darkGoldenrod’, ‘darkKhaki’, ‘hotPink’, ‘paleGreen’, ‘seaGreen’, ‘ltYellow’, ‘bisque’, ‘linen’, ‘magenta’, ‘darkViolet’, ‘lightSeaGreen’, ‘mediumOrchid’, ‘purple’, ‘mediumPurple’, ‘darkOrchid’, ‘ltGreen’, ‘lightSalmon’, ‘darkRed’, ‘tomato’, ‘saddleBrown’, ‘ltGray’, ‘dkMagenta’, ‘darkSlateGrey’, ‘medBlue’, ‘navajoWhite’, ‘cadetBlue’, ‘mediumAquamarine’, ‘paleTurquoise’, ‘medOrchid’, ‘dkOliveGreen’, ‘pink’, ‘ltPink’, ‘burlyWood’, ‘ltSlateGray’, ‘thistle’, ‘fuchsia’, ‘yellowGreen’, ‘paleGoldenrod’, ‘gainsboro’, ‘forestGreen’, ‘beige’, ‘ghostWhite’, ‘black’, ‘medSlateBlue’, ‘lightGreen’, ‘grey’, ‘ltSlateGrey’, ‘lightCyan’, ‘blueViolet’, ‘green’, ‘dkGoldenrod’, ‘deepSkyBlue’, ‘maroon’, ‘dkSlateGray’, ‘dkGrey’, ‘darkSlateBlue’, ‘dimGray’, ‘turquoise’, ‘moccasin’, ‘slateGray’, ‘blue’, ‘dkSlateGrey’, ‘yellow’, ‘lightBlue’, ‘ltCoral’, ‘deepPink’, ‘snow’, ‘limeGreen’, ‘powderBlue’, ‘darkOliveGreen’, ‘greenYellow’, ‘navy’, ‘ltGoldenrodYellow’, ‘violet’, ‘aqua’, ‘midnightBlue’, ‘dodgerBlue’, ‘cyan’, ‘dkGray’, ‘firebrick’, ‘mediumSlateBlue’, ‘skyBlue’, ‘mintCream’, ‘darkBlue’, ‘darkSeaGreen’, ‘mediumBlue’, ‘mediumTurquoise’, ‘springGreen’, ‘indianRed’, ‘oldLace’, ‘medSeaGreen’, ‘ivory’, ‘antiqueWhite’}
-
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
= 'gs'¶
-
-
class
openpyxl.drawing.fill.
LinearShadeProperties
(ang=None, scaled=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
ang
¶ Values must be of type <class ‘int’>
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
scaled
¶ Values must be of type <class ‘bool’>
-
tagname
= 'lin'¶
-
-
class
openpyxl.drawing.fill.
PathShadeProperties
(path=None, fillToRect=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
fillToRect
¶ Values must be of type <class ‘openpyxl.drawing.fill.RelativeRect’>
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
path
¶ Value must be one of {‘shape’, ‘circle’, ‘rect’}
-
tagname
= 'path'¶
-
-
class
openpyxl.drawing.fill.
PatternFillProperties
(prst=None, fgClr=None, bgClr=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
background
¶ 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”)
-
bgClr
¶ Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
-
fgClr
¶ Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
-
foreground
¶ 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”)
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
preset
¶ 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”)
-
prst
¶ Value must be one of {‘ltVert’, ‘pct70’, ‘dashHorz’, ‘dkDnDiag’, ‘ltUpDiag’, ‘lgCheck’, ‘dotDmnd’, ‘smGrid’, ‘sphere’, ‘ltHorz’, ‘weave’, ‘pct90’, ‘pct30’, ‘dashVert’, ‘zigZag’, ‘dkVert’, ‘wdUpDiag’, ‘divot’, ‘pct25’, ‘pct40’, ‘dotGrid’, ‘dashDnDiag’, ‘dkHorz’, ‘horzBrick’, ‘pct75’, ‘openDmnd’, ‘dkUpDiag’, ‘lgGrid’, ‘pct50’, ‘wave’, ‘plaid’, ‘dnDiag’, ‘narHorz’, ‘wdDnDiag’, ‘dashUpDiag’, ‘pct60’, ‘pct80’, ‘pct5’, ‘cross’, ‘lgConfetti’, ‘diagCross’, ‘pct10’, ‘smCheck’, ‘ltDnDiag’, ‘trellis’, ‘smConfetti’, ‘shingle’, ‘upDiag’, ‘solidDmnd’, ‘diagBrick’, ‘narVert’, ‘pct20’, ‘horz’, ‘vert’}
-
tagname
= 'pattFill'¶
-
-
class
openpyxl.drawing.fill.
RelativeRect
(l=None, t=None, r=None, b=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
b
¶ Values must be of type <class ‘float’>
-
bottom
¶ 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”)
-
l
¶ Values must be of type <class ‘float’>
-
left
¶ 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”)
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
r
¶ Values must be of type <class ‘float’>
-
right
¶ 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”)
-
t
¶ Values must be of type <class ‘float’>
-
tagname
= 'rect'¶
-
top
¶ 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”)
-
-
class
openpyxl.drawing.fill.
SolidColorFillProperties
(scrgbClr=None, srgbClr=None, hslClr=None, sysClr=None, schemeClr=None, prstClr=None)[source]¶ 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’>
-
prstClr
¶ Value must be one of {‘medTurquoise’, ‘ltSeaGreen’, ‘dkSeaGreen’, ‘dimGrey’, ‘lightSlateGray’, ‘whiteSmoke’, ‘medVioletRed’, ‘dkKhaki’, ‘crimson’, ‘darkGreen’, ‘steelBlue’, ‘lavender’, ‘darkGray’, ‘chartreuse’, ‘tan’, ‘sienna’, ‘dkRed’, ‘orangeRed’, ‘chocolate’, ‘white’, ‘ltBlue’, ‘dkViolet’, ‘teal’, ‘dkOrchid’, ‘dkCyan’, ‘seaShell’, ‘medSpringGreen’, ‘lightGoldenrodYellow’, ‘slateGrey’, ‘darkCyan’, ‘lightGrey’, ‘ltSteelBlue’, ‘silver’, ‘peachPuff’, ‘blanchedAlmond’, ‘plum’, ‘dkOrange’, ‘lightYellow’, ‘lightGray’, ‘darkMagenta’, ‘ltSalmon’, ‘goldenrod’, ‘lemonChiffon’, ‘darkTurquoise’, ‘sandyBrown’, ‘medAquamarine’, ‘dkTurquoise’, ‘lightPink’, ‘ltGrey’, ‘aliceBlue’, ‘mediumSpringGreen’, ‘lightSlateGrey’, ‘mistyRose’, ‘dkSalmon’, ‘darkSalmon’, ‘red’, ‘wheat’, ‘khaki’, ‘mediumSeaGreen’, ‘orange’, ‘brown’, ‘gray’, ‘darkGrey’, ‘honeydew’, ‘lightSkyBlue’, ‘ltCyan’, ‘lavenderBlush’, ‘lawnGreen’, ‘peru’, ‘aquamarine’, ‘mediumVioletRed’, ‘slateBlue’, ‘cornsilk’, ‘lightSteelBlue’, ‘dkSlateBlue’, ‘rosyBrown’, ‘floralWhite’, ‘olive’, ‘oliveDrab’, ‘gold’, ‘dkGreen’, ‘royalBlue’, ‘salmon’, ‘papayaWhip’, ‘dkBlue’, ‘ltSkyBlue’, ‘indigo’, ‘darkSlateGray’, ‘lime’, ‘medPurple’, ‘darkOrange’, ‘cornflowerBlue’, ‘orchid’, ‘paleVioletRed’, ‘lightCoral’, ‘azure’, ‘coral’, ‘darkGoldenrod’, ‘darkKhaki’, ‘hotPink’, ‘paleGreen’, ‘seaGreen’, ‘ltYellow’, ‘bisque’, ‘linen’, ‘magenta’, ‘darkViolet’, ‘lightSeaGreen’, ‘mediumOrchid’, ‘purple’, ‘mediumPurple’, ‘darkOrchid’, ‘ltGreen’, ‘lightSalmon’, ‘darkRed’, ‘tomato’, ‘saddleBrown’, ‘ltGray’, ‘dkMagenta’, ‘darkSlateGrey’, ‘medBlue’, ‘navajoWhite’, ‘cadetBlue’, ‘mediumAquamarine’, ‘paleTurquoise’, ‘medOrchid’, ‘dkOliveGreen’, ‘pink’, ‘ltPink’, ‘burlyWood’, ‘ltSlateGray’, ‘thistle’, ‘fuchsia’, ‘yellowGreen’, ‘paleGoldenrod’, ‘gainsboro’, ‘forestGreen’, ‘beige’, ‘ghostWhite’, ‘black’, ‘medSlateBlue’, ‘lightGreen’, ‘grey’, ‘ltSlateGrey’, ‘lightCyan’, ‘blueViolet’, ‘green’, ‘dkGoldenrod’, ‘deepSkyBlue’, ‘maroon’, ‘dkSlateGray’, ‘dkGrey’, ‘darkSlateBlue’, ‘dimGray’, ‘turquoise’, ‘moccasin’, ‘slateGray’, ‘blue’, ‘dkSlateGrey’, ‘yellow’, ‘lightBlue’, ‘ltCoral’, ‘deepPink’, ‘snow’, ‘limeGreen’, ‘powderBlue’, ‘darkOliveGreen’, ‘greenYellow’, ‘navy’, ‘ltGoldenrodYellow’, ‘violet’, ‘aqua’, ‘midnightBlue’, ‘dodgerBlue’, ‘cyan’, ‘dkGray’, ‘firebrick’, ‘mediumSlateBlue’, ‘skyBlue’, ‘mintCream’, ‘darkBlue’, ‘darkSeaGreen’, ‘mediumBlue’, ‘mediumTurquoise’, ‘springGreen’, ‘indianRed’, ‘oldLace’, ‘medSeaGreen’, ‘ivory’, ‘antiqueWhite’}
-
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
= 'solidFill'¶
-
-
class
openpyxl.drawing.fill.
StretchInfoProperties
(fillRect=<openpyxl.drawing.fill.RelativeRect object> Parameters: l=None, t=None, r=None, b=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
fillRect
¶ Values must be of type <class ‘openpyxl.drawing.fill.RelativeRect’>
-
namespace
= 'http://schemas.openxmlformats.org/drawingml/2006/main'¶
-
tagname
= 'stretch'¶
-
-
class
openpyxl.drawing.fill.
TileInfoProperties
(tx=None, ty=None, sx=None, sy=None, flip=None, algn=None)[source]¶ Bases:
openpyxl.descriptors.serialisable.Serialisable
-
algn
¶ Value must be one of {‘b’, ‘tl’, ‘l’, ‘tr’, ‘ctr’, ‘t’, ‘bl’, ‘r’, ‘br’}
-
flip
¶ Value must be one of {‘y’, ‘xy’, ‘x’}
-
sx
¶ Values must be of type <class ‘int’>
-
sy
¶ Values must be of type <class ‘int’>
-
tx
¶ Values must be of type <class ‘int’>
-
ty
¶ Values must be of type <class ‘int’>
-