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: 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’, ‘email’, ‘hqprint’, ‘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: b=None, r=None, l=None, t=None, srcRect=None)

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=None, lin=None, path=None, tileRect=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

flip

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

gsLst

Values must be of type <class ‘openpyxl.drawing.fill.GradientStopList’>

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 descriptve name is desired (eg. “underline” for “u”)

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 descriptve 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)

Bases: openpyxl.descriptors.serialisable.Serialisable

pos

Values must be of type <class ‘float’>

tagname = 'gradStop'

class openpyxl.drawing.fill.GradientStopList(gs=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

gs

A sequence (list or tuple) that may only contain objects of the declared type

tagname = 'gradStopLst'

class openpyxl.drawing.fill.LinearShadeProperties(ang=None, scaled=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

ang

Values must be of type <class ‘int’>

scaled

Values must be of type <class ‘bool’>

class openpyxl.drawing.fill.PathShadeProperties(path=None, fillToRect=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

fillToRect

Values must be of type <class ‘openpyxl.drawing.fill.RelativeRect’>

path

Value must be one of {‘rect’, ‘circle’, ‘shape’}

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

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 descriptve 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 descriptve 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 descriptve name is desired (eg. “underline” for “u”)

prst

Value must be one of {‘pct50’, ‘diagBrick’, ‘horz’, ‘smCheck’, ‘openDmnd’, ‘divot’, ‘plaid’, ‘wave’, ‘smConfetti’, ‘dkDnDiag’, ‘solidDmnd’, ‘zigZag’, ‘horzBrick’, ‘pct80’, ‘upDiag’, ‘pct40’, ‘dashVert’, ‘narHorz’, ‘sphere’, ‘pct20’, ‘lgConfetti’, ‘pct30’, ‘pct90’, ‘ltVert’, ‘lgGrid’, ‘narVert’, ‘trellis’, ‘pct60’, ‘dkVert’, ‘ltHorz’, ‘dashHorz’, ‘smGrid’, ‘ltDnDiag’, ‘dotDmnd’, ‘pct70’, ‘lgCheck’, ‘wdDnDiag’, ‘cross’, ‘pct75’, ‘dkUpDiag’, ‘dotGrid’, ‘pct5’, ‘dnDiag’, ‘pct25’, ‘dashUpDiag’, ‘vert’, ‘diagCross’, ‘dkHorz’, ‘wdUpDiag’, ‘dashDnDiag’, ‘pct10’, ‘ltUpDiag’, ‘weave’, ‘shingle’}

tagname = 'pattFill'

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

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 descriptve 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 descriptve 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 descriptve 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 descriptve name is desired (eg. “underline” for “u”)

class openpyxl.drawing.fill.StretchInfoProperties(fillRect=<openpyxl.drawing.fill.RelativeRect object> Parameters: b=None, r=None, l=None, t=None)

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)

Bases: openpyxl.descriptors.serialisable.Serialisable

algn

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

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