openpyxl.worksheet.table module¶

class openpyxl.worksheet.table.Table(id=1, displayName=None, ref=None, name=None, comment=None, tableType=None, headerRowCount=1, insertRow=None, insertRowShift=None, totalsRowCount=None, totalsRowShown=None, published=None, headerRowDxfId=None, dataDxfId=None, totalsRowDxfId=None, headerRowBorderDxfId=None, tableBorderDxfId=None, totalsRowBorderDxfId=None, headerRowCellStyle=None, dataCellStyle=None, totalsRowCellStyle=None, connectionId=None, autoFilter=None, sortState=None, tableColumns=(), tableStyleInfo=None, extLst=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

autoFilter¶: Values must be of type <class ‘openpyxl.worksheet.filters.AutoFilter’>

comment¶: Values must be of type <class ‘str’>

connectionId¶: Values must be of type <class ‘int’>

dataCellStyle¶: Values must be of type <class ‘str’>

dataDxfId¶: Values must be of type <class ‘int’>

displayName¶: Values must be of type <class ‘str’>

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

headerRowBorderDxfId¶: Values must be of type <class ‘int’>

headerRowCellStyle¶: Values must be of type <class ‘str’>

headerRowCount¶: Values must be of type <class ‘int’>

headerRowDxfId¶: Values must be of type <class ‘int’>

id¶: Values must be of type <class ‘int’>

insertRow¶: Values must be of type <class ‘bool’>

insertRowShift¶: Values must be of type <class ‘bool’>

mime_type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml'¶

name¶: Values must be of type <class ‘str’>

path¶: Return path within the archive

published¶: Values must be of type <class ‘bool’>

ref¶

sortState¶: Values must be of type <class ‘openpyxl.worksheet.filters.SortState’>

tableBorderDxfId¶: Values must be of type <class ‘int’>

tableColumns¶: Wrap a sequence in an containing object

tableStyleInfo¶: Values must be of type <class ‘openpyxl.worksheet.table.TableStyleInfo’>

tableType¶: Value must be one of {‘worksheet’, ‘queryTable’, ‘xml’}

tagname = 'table'¶

to_tree()[source]¶

totalsRowBorderDxfId¶: Values must be of type <class ‘int’>

totalsRowCellStyle¶: Values must be of type <class ‘str’>

totalsRowCount¶: Values must be of type <class ‘int’>

totalsRowDxfId¶: Values must be of type <class ‘int’>

totalsRowShown¶: Values must be of type <class ‘bool’>

class openpyxl.worksheet.table.TableColumn(id=None, uniqueName=None, name=None, totalsRowFunction=None, totalsRowLabel=None, queryTableFieldId=None, headerRowDxfId=None, dataDxfId=None, totalsRowDxfId=None, headerRowCellStyle=None, dataCellStyle=None, totalsRowCellStyle=None, calculatedColumnFormula=None, totalsRowFormula=None, xmlColumnPr=None, extLst=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

calculatedColumnFormula¶: Values must be of type <class ‘openpyxl.worksheet.table.TableFormula’>

dataCellStyle¶: Values must be of type <class ‘str’>

dataDxfId¶: Values must be of type <class ‘int’>

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

classmethod from_tree(node)[source]¶: Create object from XML

headerRowCellStyle¶: Values must be of type <class ‘str’>

headerRowDxfId¶: Values must be of type <class ‘int’>

id¶: Values must be of type <class ‘int’>

name¶: Values must be of type <class ‘str’>

queryTableFieldId¶: Values must be of type <class ‘int’>

tagname = 'tableColumn'¶

totalsRowCellStyle¶: Values must be of type <class ‘str’>

totalsRowDxfId¶: Values must be of type <class ‘int’>

totalsRowFormula¶: Values must be of type <class ‘openpyxl.worksheet.table.TableFormula’>

totalsRowFunction¶: Value must be one of {‘count’, ‘custom’, ‘average’, ‘sum’, ‘stdDev’, ‘max’, ‘min’, ‘countNums’, ‘var’}

totalsRowLabel¶: Values must be of type <class ‘str’>

uniqueName¶: Values must be of type <class ‘str’>

xmlColumnPr¶: Values must be of type <class ‘openpyxl.worksheet.table.XMLColumnProps’>

class openpyxl.worksheet.table.TableFormula(array=None, attr_text=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

array¶: Values must be of type <class ‘bool’>

attr_text¶

tagname = 'tableFormula'¶

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.worksheet.table.TableNameDescriptor(*args, **kw)[source]¶

Bases: openpyxl.descriptors.base.String

Table names cannot have spaces in them

class openpyxl.worksheet.table.TablePartList(count=None, tablePart=())[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

append(part)[source]¶

count¶

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

tagname = 'tableParts'¶

class openpyxl.worksheet.table.TableStyleInfo(name=None, showFirstColumn=None, showLastColumn=None, showRowStripes=None, showColumnStripes=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

name¶: Value must be one of {‘PivotStyleDark21’, ‘PivotStyleMedium13’, ‘TableStyleMedium13’, ‘TableStyleDark11’, ‘PivotStyleDark2’, ‘PivotStyleMedium22’, ‘PivotStyleLight6’, ‘PivotStyleLight13’, ‘TableStyleMedium14’, ‘PivotStyleMedium6’, ‘PivotStyleDark6’, ‘PivotStyleLight24’, ‘TableStyleMedium8’, ‘TableStyleMedium17’, ‘TableStyleDark10’, ‘TableStyleLight7’, ‘PivotStyleDark18’, ‘PivotStyleLight21’, ‘TableStyleMedium16’, ‘TableStyleMedium2’, ‘PivotStyleMedium12’, ‘PivotStyleDark20’, ‘PivotStyleLight28’, ‘TableStyleDark6’, ‘TableStyleDark5’, ‘TableStyleLight2’, ‘PivotStyleDark4’, ‘PivotStyleDark11’, ‘PivotStyleDark14’, ‘TableStyleDark9’, ‘TableStyleLight4’, ‘PivotStyleLight17’, ‘PivotStyleMedium21’, ‘PivotStyleMedium7’, ‘PivotStyleLight3’, ‘PivotStyleLight1’, ‘TableStyleMedium20’, ‘PivotStyleMedium1’, ‘TableStyleMedium11’, ‘TableStyleLight10’, ‘PivotStyleLight14’, ‘PivotStyleLight2’, ‘TableStyleLight12’, ‘PivotStyleDark1’, ‘TableStyleMedium19’, ‘PivotStyleLight9’, ‘TableStyleMedium7’, ‘PivotStyleLight18’, ‘PivotStyleDark5’, ‘PivotStyleMedium5’, ‘PivotStyleMedium2’, ‘PivotStyleDark24’, ‘PivotStyleLight7’, ‘PivotStyleMedium16’, ‘TableStyleLight21’, ‘TableStyleDark2’, ‘PivotStyleDark17’, ‘TableStyleLight16’, ‘PivotStyleMedium8’, ‘TableStyleMedium12’, ‘TableStyleMedium25’, ‘TableStyleLight15’, ‘PivotStyleDark25’, ‘PivotStyleDark22’, ‘TableStyleDark8’, ‘TableStyleLight3’, ‘TableStyleLight5’, ‘TableStyleMedium23’, ‘TableStyleLight14’, ‘TableStyleDark1’, ‘TableStyleLight11’, ‘TableStyleMedium26’, ‘TableStyleLight13’, ‘TableStyleLight17’, ‘PivotStyleDark3’, ‘PivotStyleMedium3’, ‘PivotStyleDark23’, ‘PivotStyleDark8’, ‘TableStyleLight8’, ‘PivotStyleDark19’, ‘TableStyleLight19’, ‘TableStyleMedium24’, ‘PivotStyleMedium10’, ‘PivotStyleMedium26’, ‘PivotStyleLight10’, ‘TableStyleMedium18’, ‘PivotStyleDark27’, ‘PivotStyleMedium24’, ‘PivotStyleMedium18’, ‘TableStyleDark3’, ‘PivotStyleLight20’, ‘TableStyleMedium6’, ‘PivotStyleDark12’, ‘TableStyleLight20’, ‘TableStyleMedium9’, ‘PivotStyleMedium19’, ‘PivotStyleMedium20’, ‘PivotStyleLight23’, ‘PivotStyleLight25’, ‘PivotStyleDark28’, ‘PivotStyleDark10’, ‘TableStyleMedium4’, ‘PivotStyleLight4’, ‘PivotStyleLight15’, ‘PivotStyleLight11’, ‘PivotStyleLight8’, ‘PivotStyleMedium28’, ‘TableStyleDark4’, ‘TableStyleMedium21’, ‘PivotStyleMedium14’, ‘PivotStyleDark9’, ‘PivotStyleLight26’, ‘TableStyleLight6’, ‘PivotStyleDark16’, ‘TableStyleLight18’, ‘PivotStyleMedium11’, ‘TableStyleMedium15’, ‘TableStyleMedium27’, ‘PivotStyleMedium9’, ‘PivotStyleDark26’, ‘PivotStyleMedium17’, ‘TableStyleLight9’, ‘PivotStyleLight27’, ‘PivotStyleDark7’, ‘PivotStyleLight5’, ‘PivotStyleLight22’, ‘PivotStyleMedium15’, ‘PivotStyleMedium23’, ‘TableStyleMedium1’, ‘TableStyleMedium3’, ‘PivotStyleMedium25’, ‘PivotStyleDark15’, ‘TableStyleMedium5’, ‘PivotStyleMedium27’, ‘TableStyleDark7’, ‘PivotStyleDark13’, ‘TableStyleMedium10’, ‘PivotStyleLight12’, ‘PivotStyleLight16’, ‘PivotStyleLight19’, ‘TableStyleLight1’, ‘PivotStyleMedium4’, ‘TableStyleMedium22’, ‘TableStyleMedium28’}

showColumnStripes¶: Values must be of type <class ‘bool’>

showFirstColumn¶: Values must be of type <class ‘bool’>

showLastColumn¶: Values must be of type <class ‘bool’>

showRowStripes¶: Values must be of type <class ‘bool’>

tagname = 'tableStyleInfo'¶

class openpyxl.worksheet.table.XMLColumnProps(mapId=None, xpath=None, denormalized=None, xmlDataType=None, extLst=None)[source]¶

Bases: openpyxl.descriptors.serialisable.Serialisable

denormalized¶: Values must be of type <class ‘bool’>

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

mapId¶: Values must be of type <class ‘int’>

tagname = 'xmlColumnPr'¶

xmlDataType¶: Values must be of type <class ‘str’>

xpath¶: Values must be of type <class ‘str’>