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:
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 {‘email’, ‘hqprint’, ‘print’, ‘screen’}
- 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:
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:
Serialisable- flip
Value must be one of {‘xy’, ‘y’, ‘x’}
- gsLst
Wrap a sequence in an containing object
- lin
Values must be of type <class ‘openpyxl.drawing.fill.LinearShadeProperties’>
- linear
Values must be of type <class ‘openpyxl.drawing.fill.LinearShadeProperties’>
- 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
Wrap a sequence in an containing object
- 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:
Serialisable- RGB
Values must be of type <class ‘str’>
- RGBPercent
Values must be of type <class ‘openpyxl.drawing.colors.RGBPercent’>
- 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 {‘linen’, ‘saddleBrown’, ‘tan’, ‘lavenderBlush’, ‘mediumPurple’, ‘coral’, ‘aliceBlue’, ‘red’, ‘slateGray’, ‘mediumBlue’, ‘dkSlateBlue’, ‘lightBlue’, ‘ltGoldenrodYellow’, ‘dimGrey’, ‘lightSlateGrey’, ‘lightYellow’, ‘rosyBrown’, ‘dkRed’, ‘whiteSmoke’, ‘ltSeaGreen’, ‘ltSteelBlue’, ‘dkBlue’, ‘medVioletRed’, ‘lightSalmon’, ‘seaGreen’, ‘lightSkyBlue’, ‘skyBlue’, ‘gainsboro’, ‘lightCoral’, ‘darkBlue’, ‘darkOliveGreen’, ‘deepPink’, ‘hotPink’, ‘mediumSeaGreen’, ‘fuchsia’, ‘dkKhaki’, ‘sienna’, ‘silver’, ‘cornsilk’, ‘darkSeaGreen’, ‘dkTurquoise’, ‘blue’, ‘ltGray’, ‘lightSteelBlue’, ‘medSlateBlue’, ‘grey’, ‘mediumSlateBlue’, ‘lightSlateGray’, ‘ltGrey’, ‘yellow’, ‘ivory’, ‘forestGreen’, ‘medOrchid’, ‘mintCream’, ‘paleGoldenrod’, ‘plum’, ‘darkOrchid’, ‘royalBlue’, ‘tomato’, ‘lightCyan’, ‘lightPink’, ‘dkCyan’, ‘ltSlateGray’, ‘ltSkyBlue’, ‘paleGreen’, ‘cadetBlue’, ‘ghostWhite’, ‘medAquamarine’, ‘gray’, ‘midnightBlue’, ‘darkOrange’, ‘green’, ‘mediumVioletRed’, ‘darkGrey’, ‘slateBlue’, ‘ltYellow’, ‘blueViolet’, ‘turquoise’, ‘medTurquoise’, ‘lemonChiffon’, ‘ltSlateGrey’, ‘darkGoldenrod’, ‘goldenrod’, ‘snow’, ‘mistyRose’, ‘dkGrey’, ‘salmon’, ‘aquamarine’, ‘darkKhaki’, ‘gold’, ‘medPurple’, ‘oliveDrab’, ‘darkRed’, ‘honeydew’, ‘dkOliveGreen’, ‘dkGray’, ‘navajoWhite’, ‘papayaWhip’, ‘darkMagenta’, ‘ltCoral’, ‘ltCyan’, ‘brown’, ‘medSpringGreen’, ‘darkSlateBlue’, ‘mediumOrchid’, ‘orangeRed’, ‘oldLace’, ‘dkGreen’, ‘thistle’, ‘dkSeaGreen’, ‘dkMagenta’, ‘dkOrange’, ‘wheat’, ‘mediumAquamarine’, ‘darkSalmon’, ‘ltGreen’, ‘orchid’, ‘dkOrchid’, ‘darkSlateGrey’, ‘lightGoldenrodYellow’, ‘navy’, ‘deepSkyBlue’, ‘paleVioletRed’, ‘ltBlue’, ‘beige’, ‘indigo’, ‘steelBlue’, ‘teal’, ‘moccasin’, ‘olive’, ‘dodgerBlue’, ‘maroon’, ‘medBlue’, ‘ltPink’, ‘violet’, ‘bisque’, ‘lightSeaGreen’, ‘powderBlue’, ‘paleTurquoise’, ‘ltSalmon’, ‘antiqueWhite’, ‘seaShell’, ‘lightGray’, ‘chocolate’, ‘dkSalmon’, ‘cornflowerBlue’, ‘lightGreen’, ‘peru’, ‘lawnGreen’, ‘slateGrey’, ‘dkViolet’, ‘blanchedAlmond’, ‘pink’, ‘indianRed’, ‘crimson’, ‘darkViolet’, ‘darkGreen’, ‘limeGreen’, ‘yellowGreen’, ‘firebrick’, ‘sandyBrown’, ‘floralWhite’, ‘lavender’, ‘mediumSpringGreen’, ‘medSeaGreen’, ‘peachPuff’, ‘dkSlateGrey’, ‘chartreuse’, ‘purple’, ‘darkGray’, ‘springGreen’, ‘dimGray’, ‘magenta’, ‘orange’, ‘burlyWood’, ‘dkSlateGray’, ‘greenYellow’, ‘khaki’, ‘lime’, ‘black’, ‘lightGrey’, ‘white’, ‘darkCyan’, ‘azure’, ‘dkGoldenrod’, ‘darkSlateGray’, ‘mediumTurquoise’, ‘aqua’, ‘cyan’, ‘darkTurquoise’}
- 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:
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:
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’, ‘rect’, ‘circle’}
- tagname = 'path'
- class openpyxl.drawing.fill.PatternFillProperties(prst=None, fgClr=None, bgClr=None)[source]
Bases:
Serialisable- background
Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
- bgClr
Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
- fgClr
Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
- foreground
Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>
- namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'
- preset
Value must be one of {‘dkHorz’, ‘narHorz’, ‘diagCross’, ‘wdDnDiag’, ‘dashUpDiag’, ‘lgGrid’, ‘dkUpDiag’, ‘vert’, ‘dotGrid’, ‘pct70’, ‘weave’, ‘pct25’, ‘dkDnDiag’, ‘dashDnDiag’, ‘pct40’, ‘ltDnDiag’, ‘diagBrick’, ‘openDmnd’, ‘pct20’, ‘lgCheck’, ‘pct60’, ‘dnDiag’, ‘dkVert’, ‘horzBrick’, ‘horz’, ‘solidDmnd’, ‘pct10’, ‘dotDmnd’, ‘pct5’, ‘plaid’, ‘pct30’, ‘lgConfetti’, ‘ltHorz’, ‘sphere’, ‘narVert’, ‘cross’, ‘pct80’, ‘pct90’, ‘pct50’, ‘upDiag’, ‘smConfetti’, ‘zigZag’, ‘ltUpDiag’, ‘smCheck’, ‘dashHorz’, ‘smGrid’, ‘pct75’, ‘dashVert’, ‘ltVert’, ‘divot’, ‘shingle’, ‘wdUpDiag’, ‘wave’, ‘trellis’}
- prst
Value must be one of {‘dkHorz’, ‘narHorz’, ‘diagCross’, ‘wdDnDiag’, ‘dashUpDiag’, ‘lgGrid’, ‘dkUpDiag’, ‘vert’, ‘dotGrid’, ‘pct70’, ‘weave’, ‘pct25’, ‘dkDnDiag’, ‘dashDnDiag’, ‘pct40’, ‘ltDnDiag’, ‘diagBrick’, ‘openDmnd’, ‘pct20’, ‘lgCheck’, ‘pct60’, ‘dnDiag’, ‘dkVert’, ‘horzBrick’, ‘horz’, ‘solidDmnd’, ‘pct10’, ‘dotDmnd’, ‘pct5’, ‘plaid’, ‘pct30’, ‘lgConfetti’, ‘ltHorz’, ‘sphere’, ‘narVert’, ‘cross’, ‘pct80’, ‘pct90’, ‘pct50’, ‘upDiag’, ‘smConfetti’, ‘zigZag’, ‘ltUpDiag’, ‘smCheck’, ‘dashHorz’, ‘smGrid’, ‘pct75’, ‘dashVert’, ‘ltVert’, ‘divot’, ‘shingle’, ‘wdUpDiag’, ‘wave’, ‘trellis’}
- tagname = 'pattFill'
- class openpyxl.drawing.fill.RelativeRect(l=None, t=None, r=None, b=None)[source]
Bases:
Serialisable- b
Values must be of type <class ‘float’>
- bottom
Values must be of type <class ‘float’>
- l
Values must be of type <class ‘float’>
- left
Values must be of type <class ‘float’>
- namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'
- r
Values must be of type <class ‘float’>
- right
Values must be of type <class ‘float’>
- t
Values must be of type <class ‘float’>
- tagname = 'rect'
- top
Values must be of type <class ‘float’>
- class openpyxl.drawing.fill.SolidColorFillProperties(scrgbClr=None, srgbClr=None, hslClr=None, sysClr=None, schemeClr=None, prstClr=None)[source]
Bases:
Serialisable- RGB
Values must be of type <class ‘str’>
- RGBPercent
Values must be of type <class ‘openpyxl.drawing.colors.RGBPercent’>
- hslClr
Values must be of type <class ‘openpyxl.drawing.colors.HSLColor’>
- prstClr
Value must be one of {‘linen’, ‘saddleBrown’, ‘tan’, ‘lavenderBlush’, ‘mediumPurple’, ‘coral’, ‘aliceBlue’, ‘red’, ‘slateGray’, ‘mediumBlue’, ‘dkSlateBlue’, ‘lightBlue’, ‘ltGoldenrodYellow’, ‘dimGrey’, ‘lightSlateGrey’, ‘lightYellow’, ‘rosyBrown’, ‘dkRed’, ‘whiteSmoke’, ‘ltSeaGreen’, ‘ltSteelBlue’, ‘dkBlue’, ‘medVioletRed’, ‘lightSalmon’, ‘seaGreen’, ‘lightSkyBlue’, ‘skyBlue’, ‘gainsboro’, ‘lightCoral’, ‘darkBlue’, ‘darkOliveGreen’, ‘deepPink’, ‘hotPink’, ‘mediumSeaGreen’, ‘fuchsia’, ‘dkKhaki’, ‘sienna’, ‘silver’, ‘cornsilk’, ‘darkSeaGreen’, ‘dkTurquoise’, ‘blue’, ‘ltGray’, ‘lightSteelBlue’, ‘medSlateBlue’, ‘grey’, ‘mediumSlateBlue’, ‘lightSlateGray’, ‘ltGrey’, ‘yellow’, ‘ivory’, ‘forestGreen’, ‘medOrchid’, ‘mintCream’, ‘paleGoldenrod’, ‘plum’, ‘darkOrchid’, ‘royalBlue’, ‘tomato’, ‘lightCyan’, ‘lightPink’, ‘dkCyan’, ‘ltSlateGray’, ‘ltSkyBlue’, ‘paleGreen’, ‘cadetBlue’, ‘ghostWhite’, ‘medAquamarine’, ‘gray’, ‘midnightBlue’, ‘darkOrange’, ‘green’, ‘mediumVioletRed’, ‘darkGrey’, ‘slateBlue’, ‘ltYellow’, ‘blueViolet’, ‘turquoise’, ‘medTurquoise’, ‘lemonChiffon’, ‘ltSlateGrey’, ‘darkGoldenrod’, ‘goldenrod’, ‘snow’, ‘mistyRose’, ‘dkGrey’, ‘salmon’, ‘aquamarine’, ‘darkKhaki’, ‘gold’, ‘medPurple’, ‘oliveDrab’, ‘darkRed’, ‘honeydew’, ‘dkOliveGreen’, ‘dkGray’, ‘navajoWhite’, ‘papayaWhip’, ‘darkMagenta’, ‘ltCoral’, ‘ltCyan’, ‘brown’, ‘medSpringGreen’, ‘darkSlateBlue’, ‘mediumOrchid’, ‘orangeRed’, ‘oldLace’, ‘dkGreen’, ‘thistle’, ‘dkSeaGreen’, ‘dkMagenta’, ‘dkOrange’, ‘wheat’, ‘mediumAquamarine’, ‘darkSalmon’, ‘ltGreen’, ‘orchid’, ‘dkOrchid’, ‘darkSlateGrey’, ‘lightGoldenrodYellow’, ‘navy’, ‘deepSkyBlue’, ‘paleVioletRed’, ‘ltBlue’, ‘beige’, ‘indigo’, ‘steelBlue’, ‘teal’, ‘moccasin’, ‘olive’, ‘dodgerBlue’, ‘maroon’, ‘medBlue’, ‘ltPink’, ‘violet’, ‘bisque’, ‘lightSeaGreen’, ‘powderBlue’, ‘paleTurquoise’, ‘ltSalmon’, ‘antiqueWhite’, ‘seaShell’, ‘lightGray’, ‘chocolate’, ‘dkSalmon’, ‘cornflowerBlue’, ‘lightGreen’, ‘peru’, ‘lawnGreen’, ‘slateGrey’, ‘dkViolet’, ‘blanchedAlmond’, ‘pink’, ‘indianRed’, ‘crimson’, ‘darkViolet’, ‘darkGreen’, ‘limeGreen’, ‘yellowGreen’, ‘firebrick’, ‘sandyBrown’, ‘floralWhite’, ‘lavender’, ‘mediumSpringGreen’, ‘medSeaGreen’, ‘peachPuff’, ‘dkSlateGrey’, ‘chartreuse’, ‘purple’, ‘darkGray’, ‘springGreen’, ‘dimGray’, ‘magenta’, ‘orange’, ‘burlyWood’, ‘dkSlateGray’, ‘greenYellow’, ‘khaki’, ‘lime’, ‘black’, ‘lightGrey’, ‘white’, ‘darkCyan’, ‘azure’, ‘dkGoldenrod’, ‘darkSlateGray’, ‘mediumTurquoise’, ‘aqua’, ‘cyan’, ‘darkTurquoise’}
- 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:
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:
Serialisable- algn
Value must be one of {‘tr’, ‘r’, ‘tl’, ‘br’, ‘t’, ‘bl’, ‘ctr’, ‘l’, ‘b’}
- flip
Value must be one of {‘xy’, ‘y’, ‘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’>