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)

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’, ‘screen’, ‘hqprint’, ‘print’}

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)

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)

Bases: Serialisable

flip

Value must be one of {‘y’, ‘x’, ‘xy’}

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)

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

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)

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)

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 {‘circle’, ‘rect’, ‘shape’}

tagname = 'path'

class openpyxl.drawing.fill.PatternFillProperties(prst=None, fgClr=None, bgClr=None)

Bases: 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 {‘pct90’, ‘dashVert’, ‘dnDiag’, ‘wdUpDiag’, ‘dashUpDiag’, ‘diagCross’, ‘plaid’, ‘dotDmnd’, ‘dotGrid’, ‘dkHorz’, ‘lgCheck’, ‘ltUpDiag’, ‘smCheck’, ‘wave’, ‘pct80’, ‘divot’, ‘dkUpDiag’, ‘narVert’, ‘ltVert’, ‘dkDnDiag’, ‘weave’, ‘shingle’, ‘zigZag’, ‘pct70’, ‘pct25’, ‘upDiag’, ‘lgConfetti’, ‘smConfetti’, ‘trellis’, ‘ltHorz’, ‘pct75’, ‘pct30’, ‘pct5’, ‘dashDnDiag’, ‘pct40’, ‘cross’, ‘horzBrick’, ‘pct50’, ‘pct60’, ‘pct10’, ‘dkVert’, ‘lgGrid’, ‘sphere’, ‘dashHorz’, ‘pct20’, ‘diagBrick’, ‘solidDmnd’, ‘narHorz’, ‘vert’, ‘openDmnd’, ‘wdDnDiag’, ‘smGrid’, ‘horz’, ‘ltDnDiag’}

tagname = 'pattFill'

class openpyxl.drawing.fill.RelativeRect(l=None, t=None, r=None, b=None)

Bases: 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)

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

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)

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)

Bases: Serialisable

algn

Value must be one of {‘b’, ‘tl’, ‘r’, ‘bl’, ‘l’, ‘ctr’, ‘tr’, ‘t’, ‘br’}

flip

Value must be one of {‘y’, ‘x’, ‘xy’}

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’>