openpyxl.drawing.text module

class openpyxl.drawing.text.AutonumberBullet(type=None, startAt=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

startAt

Values must be of type <class ‘int’>

type

Value must be one of {‘hebrew2Minus’, ‘circleNumDbPlain’, ‘arabic1Minus’, ‘hindiAlpha1Period’, ‘arabicPeriod’, ‘alphaLcParenR’, ‘romanLcPeriod’, ‘hindiNumParenR’, ‘arabicParenR’, ‘ea1JpnChsDbPeriod’, ‘alphaUcParenBoth’, ‘ea1JpnKorPeriod’, ‘arabicDbPlain’, ‘arabic2Minus’, ‘arabicPlain’, ‘circleNumWdBlackPlain’, ‘thaiAlphaPeriod’, ‘hindiAlphaPeriod’, ‘ea1JpnKorPlain’, ‘ea1ChsPlain’, ‘arabicDbPeriod’, ‘ea1ChsPeriod’, ‘thaiNumParenR’, ‘circleNumWdWhitePlain’, ‘romanUcParenBoth’, ‘romanUcParenR’, ‘alphaLcPeriod’, ‘romanUcPeriod’, ‘thaiAlphaParenBoth’, ‘ea1ChtPlain’, ‘thaiNumParenBoth’, ‘hindiNumPeriod’, ‘alphaLcParenBoth’, ‘romanLcParenR’, ‘thaiAlphaParenR’, ‘ea1ChtPeriod’, ‘alphaUcParenR’, ‘arabicParenBoth’, ‘alphaUcPeriod’, ‘thaiNumPeriod’, ‘romanLcParenBoth’}

class openpyxl.drawing.text.CharacterProperties(kumimoji=None, lang=None, altLang=None, sz=None, b=None, i=None, u=None, strike=None, kern=None, cap=None, spc=None, normalizeH=None, baseline=None, noProof=None, dirty=None, err=None, smtClean=None, smtId=None, bmk=None, ln=None, highlight=None, latin=None, ea=None, cs=None, sym=None, hlinkClick=None, hlinkMouseOver=None, rtl=None, extLst=None, noFill=None, solidFill=None, gradFill=None, blipFill=None, pattFill=None, grpFill=None, effectLst=None, effectDag=None, uLnTx=None, uLn=None, uFillTx=None, uFill=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

altLang

Values must be of type <class ‘str’>

b

Values must be of type <class ‘bool’>

baseline

Values must be of type <class ‘int’>

blipFill

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

bmk

Values must be of type <class ‘str’>

cap

Value must be one of {‘all’, ‘small’}

cs

Values must be of type <class ‘openpyxl.drawing.text.Font’>

dirty

Values must be of type <class ‘bool’>

ea

Values must be of type <class ‘openpyxl.drawing.text.Font’>

effectDag

Values must be of type <class ‘openpyxl.drawing.effect.EffectContainer’>

effectLst

Values must be of type <class ‘openpyxl.drawing.effect.EffectList’>

err

Values must be of type <class ‘bool’>

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

gradFill

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

grpFill

Values must be of type <class ‘bool’>

highlight

Values must be of type <class ‘openpyxl.styles.colors.Color’>

hlinkClick

Values must be of type <class ‘openpyxl.drawing.text.Hyperlink’>

hlinkMouseOver

Values must be of type <class ‘openpyxl.drawing.text.Hyperlink’>

i

Values must be of type <class ‘bool’>

kern

Values must be of type <class ‘int’>

kumimoji

Values must be of type <class ‘bool’>

lang

Values must be of type <class ‘str’>

latin

Values must be of type <class ‘openpyxl.drawing.text.Font’>

ln

Values must be of type <class ‘openpyxl.drawing.line.LineProperties’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

noFill

Values must be of type <class ‘bool’>

noProof

Values must be of type <class ‘bool’>

normalizeH

Values must be of type <class ‘bool’>

pattFill

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

rtl

Values must be of type <class ‘bool’>

smtClean

Values must be of type <class ‘bool’>

smtId

Values must be of type <class ‘int’>

solidFill

Values must be of type <class ‘openpyxl.drawing.colors.ColorChoice’>

spc

Values must be of type <class ‘int’>

strike

Value must be one of {‘dblStrike’, ‘noStrike’, ‘sngStrike’}

sym

Values must be of type <class ‘openpyxl.drawing.text.Font’>

sz

Values must be of type <class ‘float’>

tagname = 'defRPr'

u

Value must be one of {‘dotDashHeavy’, ‘dotDotDashHeavy’, ‘dashLongHeavy’, ‘wavyDbl’, ‘dash’, ‘wavy’, ‘dashLong’, ‘heavy’, ‘dotted’, ‘dottedHeavy’, ‘words’, ‘dotDotDash’, ‘wavyHeavy’, ‘dbl’, ‘sng’, ‘dashHeavy’, ‘dotDash’}

uFill

Values must be of type <class ‘bool’>

uFillTx

Values must be of type <class ‘bool’>

uLn

Values must be of type <class ‘openpyxl.drawing.line.LineProperties’>

uLnTx

Values must be of type <class ‘bool’>

class openpyxl.drawing.text.EmbeddedWAVAudioFile(name=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

name

Values must be of type <class ‘openpyxl.descriptors.base.String’>

class openpyxl.drawing.text.Font(typeface=None, panose=None, pitchFamily=None, charset=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

charset

Values must be of type <class ‘openpyxl.descriptors.base.MinMax’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

panose

Values must be of type <class ‘openpyxl.descriptors.excel.HexBinary’>

pitchFamily

Values must be of type <class ‘openpyxl.descriptors.base.MinMax’>

tagname = 'latin'

typeface

Values must be of type <class ‘str’>

class openpyxl.drawing.text.GeomGuide(name=None, fmla=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

fmla

Values must be of type Values must be of type <class ‘str’>

name

Values must be of type Values must be of type <class ‘str’>

class openpyxl.drawing.text.GeomGuideList(gd=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

gd

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

class openpyxl.drawing.text.Hyperlink(invalidUrl=None, action=None, tgtFrame=None, tooltip=None, history=None, highlightClick=None, endSnd=None, snd=None, extLst=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

action

Values must be of type <class ‘openpyxl.descriptors.base.String’>

endSnd

Values must be of type <class ‘openpyxl.descriptors.base.Bool’>

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

highlightClick

Values must be of type <class ‘openpyxl.descriptors.base.Bool’>

history

Values must be of type <class ‘openpyxl.descriptors.base.Bool’>

invalidUrl

Values must be of type <class ‘openpyxl.descriptors.base.String’>

snd

Values must be of type <class ‘openpyxl.drawing.text.EmbeddedWAVAudioFile’>

tgtFrame

Values must be of type <class ‘openpyxl.descriptors.base.String’>

tooltip

Values must be of type <class ‘openpyxl.descriptors.base.String’>

class openpyxl.drawing.text.LineBreak(rPr=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

rPr

Values must be of type <class ‘openpyxl.drawing.text.CharacterProperties’>

class openpyxl.drawing.text.ListStyle(defPPr=None, lvl1pPr=None, lvl2pPr=None, lvl3pPr=None, lvl4pPr=None, lvl5pPr=None, lvl6pPr=None, lvl7pPr=None, lvl8pPr=None, lvl9pPr=None, extLst=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

defPPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

lvl1pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl2pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl3pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl4pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl5pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl6pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl7pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl8pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

lvl9pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

tagname = 'lstStyle'

class openpyxl.drawing.text.Paragraph(pPr=None, endParaRPr=None, r=None, br=None, fld=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

br

Values must be of type <class ‘openpyxl.drawing.text.LineBreak’>

endParaRPr

Values must be of type <class ‘openpyxl.drawing.text.CharacterProperties’>

fld

Values must be of type <class ‘openpyxl.drawing.text.TextField’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

properties

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

r

Values must be of type <class ‘openpyxl.drawing.text.RegularTextRun’>

tagname = 'p'

text

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.text.ParagraphProperties(marL=None, marR=None, lvl=None, indent=None, algn=None, defTabSz=None, rtl=None, eaLnBrk=None, fontAlgn=None, latinLnBrk=None, hangingPunct=None, lnSpc=None, spcBef=None, spcAft=None, tabLst=None, defRPr=None, extLst=None, buClrTx=None, buClr=None, buSzTx=None, buSzPct=None, buSzPts=None, buFontTx=None, buFont=None, buNone=None, buAutoNum=None, buChar=None, buBlip=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

algn

Value must be one of {‘ctr’, ‘justLow’, ‘r’, ‘l’, ‘dist’, ‘just’, ‘thaiDist’}

buAutoNum

Values must be of type <class ‘bool’>

buBlip

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

buChar

Values must be of type <class ‘str’>

buClr

Values must be of type <class ‘openpyxl.styles.colors.Color’>

buClrTx

Values must be of type <class ‘bool’>

buFont

Values must be of type <class ‘openpyxl.drawing.text.Font’>

buFontTx

Values must be of type <class ‘bool’>

buNone

Values must be of type <class ‘bool’>

buSzPct

Values must be of type <class ‘int’>

buSzPts

Values must be of type <class ‘int’>

buSzTx

Values must be of type <class ‘bool’>

defRPr

Values must be of type <class ‘openpyxl.drawing.text.CharacterProperties’>

defTabSz

Values must be of type <class ‘openpyxl.descriptors.base.Integer’>

eaLnBrk

Values must be of type <class ‘bool’>

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

fontAlgn

Value must be one of {‘base’, ‘ctr’, ‘auto’, ‘b’, ‘t’}

hangingPunct

Values must be of type <class ‘bool’>

indent

Values must be of type <class ‘int’>

latinLnBrk

Values must be of type <class ‘bool’>

lnSpc

Values must be of type <class ‘openpyxl.drawing.text.Spacing’>

lvl

Values must be of type <class ‘int’>

marL

Values must be of type <class ‘int’>

marR

Values must be of type <class ‘int’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

rtl

Values must be of type <class ‘bool’>

spcAft

Values must be of type <class ‘openpyxl.drawing.text.Spacing’>

spcBef

Values must be of type <class ‘openpyxl.drawing.text.Spacing’>

tabLst

Values must be of type <class ‘openpyxl.drawing.text.TabStopList’>

tagname = 'pPr'

class openpyxl.drawing.text.PresetTextShape(prst=None, avLst=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

avLst

Values must be of type <class ‘openpyxl.drawing.text.GeomGuideList’>

prst

Values must be of type <openpyxl.descriptors.base.Set object at 0x7f9578ab2c50>

class openpyxl.drawing.text.RegularTextRun(rPr=None, t=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

properties

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

rPr

Values must be of type <class ‘openpyxl.drawing.text.CharacterProperties’>

t

Values must be of type <class ‘str’>

tagname = 'r'

value

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.text.RichTextProperties(rot=None, spcFirstLastPara=None, vertOverflow=None, horzOverflow=None, vert=None, wrap=None, lIns=None, tIns=None, rIns=None, bIns=None, numCol=None, spcCol=None, rtlCol=None, fromWordArt=None, anchor=None, anchorCtr=None, forceAA=None, upright=None, compatLnSpc=None, prstTxWarp=None, scene3d=None, extLst=None, noAutofit=None, normAutofit=None, spAutoFit=None, flatTx=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

anchor

Value must be one of {‘dist’, ‘b’, ‘ctr’, ‘just’, ‘t’}

anchorCtr

Values must be of type <class ‘bool’>

bIns

Values must be of type <class ‘int’>

compatLnSpc

Values must be of type <class ‘bool’>

extLst

Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

flatTx

Values must be of type <class ‘int’>

forceAA

Values must be of type <class ‘bool’>

fromWordArt

Values must be of type <class ‘bool’>

horzOverflow

Value must be one of {‘clip’, ‘overflow’}

lIns

Values must be of type <class ‘int’>

namespace = 'http://schemas.openxmlformats.org/drawingml/2006/main'

noAutofit

Values must be of type <class ‘bool’>

normAutofit

Values must be of type <class ‘bool’>

numCol

Values must be of type <class ‘int’>

prstTxWarp

Values must be of type <class ‘openpyxl.drawing.text.PresetTextShape’>

rIns

Values must be of type <class ‘int’>

rot

Values must be of type <class ‘int’>

rtlCol

Values must be of type <class ‘bool’>

scene3d

Values must be of type <class ‘openpyxl.drawing.shapes.Scene3D’>

spAutoFit

Values must be of type <class ‘bool’>

spcCol

Values must be of type <class ‘int’>

spcFirstLastPara

Values must be of type <class ‘bool’>

tIns

Values must be of type <class ‘int’>

tagname = 'bodyPr'

upright

Values must be of type <class ‘bool’>

vert

Value must be one of {‘vert’, ‘horz’, ‘wordArtVert’, ‘eaVert’, ‘wordArtVertRtl’, ‘vert270’, ‘mongolianVert’}

vertOverflow

Value must be one of {‘clip’, ‘ellipsis’, ‘overflow’}

wrap

Value must be one of {‘square’, ‘none’}

class openpyxl.drawing.text.Spacing(spcPct=None, spcPts=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

spcPct

Values must be of type <class ‘int’>

spcPts

Values must be of type <class ‘int’>

class openpyxl.drawing.text.TabStop(pos=None, algn=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

algn

Values must be of type <openpyxl.descriptors.base.Set object at 0x7f9578a34a58>

pos

Values must be of type <class ‘openpyxl.descriptors.base.Integer’>

class openpyxl.drawing.text.TabStopList(tab=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

tab

Values must be of type <class ‘openpyxl.drawing.text.TabStop’>

class openpyxl.drawing.text.TextField(id=None, type=None, rPr=None, pPr=None, t=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

id

Values must be of type <class ‘str’>

pPr

Values must be of type <class ‘openpyxl.drawing.text.ParagraphProperties’>

rPr

Values must be of type <class ‘openpyxl.drawing.text.CharacterProperties’>

t

Values must be of type <class ‘openpyxl.descriptors.base.String’>

type

Values must be of type <class ‘str’>

class openpyxl.drawing.text.TextNormalAutofit(fontScale=None, lnSpcReduction=None)

Bases: openpyxl.descriptors.serialisable.Serialisable

fontScale

Values must be of type <class ‘int’>

lnSpcReduction

Values must be of type <class ‘int’>