# 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’, ‘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)

  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 [‘x’, ‘xy’, ‘y’]

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

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

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

  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’, ‘bl’, ‘br’, ‘ctr’, ‘l’, ‘r’, ‘t’, ‘tl’, ‘tr’]

  flip

    Value must be one of [‘x’, ‘xy’, ‘y’]

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