fastpyxl.pivot.table module

class fastpyxl.pivot.table.AutoSortScope(pivotArea=None)

Bases: Serialisable

pivotArea: PivotArea | None

xml_order = ('pivotArea',)

class fastpyxl.pivot.table.ChartFormat(chart=None, format=None, series=None, pivotArea=None)

Bases: Serialisable

chart: int | None

format: int | None

pivotArea: PivotArea | None

series: bool | None

tagname = 'chartFormat'

xml_order = ('pivotArea',)

class fastpyxl.pivot.table.ColHierarchiesUsage(count=None, colHierarchyUsage=())

Bases: Serialisable

colHierarchyUsage: list[HierarchyUsage]

property count

tagname = 'colHierarchiesUsage'

xml_order = ('colHierarchyUsage',)

class fastpyxl.pivot.table.ConditionalFormat(scope='selection', type=None, priority=None, pivotAreas=(), extLst=None)

Bases: Serialisable

extLst: ExtensionList | None

pivotAreas: list[PivotArea]

priority: int | None

scope: str | None

tagname = 'conditionalFormat'

type: str | None

xml_order = ('pivotAreas',)

class fastpyxl.pivot.table.ConditionalFormatList(conditionalFormat=(), count=None)

Bases: Serialisable

by_priority()

Return a dictionary of format objects keyed by (field id and format property). This can be used to map the formats to field but also to dedupe to match worksheet definitions which are grouped by cell range

conditionalFormat: list[ConditionalFormat]

property count

tagname = 'conditionalFormats'

to_tree(tagname=None)

class fastpyxl.pivot.table.DataField(name=None, fld=None, subtotal='sum', showDataAs='normal', baseField=-1, baseItem=1048832, numFmtId=None, extLst=None)

Bases: Serialisable

baseField: int | None

baseItem: int | None

extLst: ExtensionList | None

fld: int | None

name: str | None

numFmtId: int | None

showDataAs: str | None

subtotal: str | None

tagname = 'dataField'

xml_order = ()

class fastpyxl.pivot.table.FieldItem(n=None, t='data', h=None, s=None, sd=True, f=None, m=None, c=None, x=None, d=None, e=None)

Bases: Serialisable

c: bool | None

d: bool | None

e: bool | None

f: bool | None

h: bool | None

m: bool | None

n: str | None

s: bool | None

sd: bool | None

t: str | None

tagname = 'item'

x: int | None

class fastpyxl.pivot.table.Format(action='formatting', dxfId=None, pivotArea=None, extLst=None)

Bases: Serialisable

action: str | None

dxfId: int | None

extLst: ExtensionList | None

pivotArea: PivotArea | None

tagname = 'format'

xml_order = ('pivotArea',)

class fastpyxl.pivot.table.HierarchyUsage(hierarchyUsage=None)

Bases: Serialisable

hierarchyUsage: int | None

tagname = 'hierarchyUsage'

class fastpyxl.pivot.table.Location(ref=None, firstHeaderRow=None, firstDataRow=None, firstDataCol=None, rowPageCount=None, colPageCount=None)

Bases: Serialisable

colPageCount: int | None

firstDataCol: int | None

firstDataRow: int | None

firstHeaderRow: int | None

ref: str | None

rowPageCount: int | None

tagname = 'location'

class fastpyxl.pivot.table.MemberList(count=None, level=None, member=())

Bases: Serialisable

property count

level: int | None

member: list[str]

tagname = 'members'

xml_order = ('member',)

class fastpyxl.pivot.table.MemberProperty(name=None, showCell=None, showTip=None, showAsCaption=None, nameLen=None, pPos=None, pLen=None, level=None, field=None)

Bases: Serialisable

field: int | None

level: int | None

name: str | None

nameLen: int | None

pLen: int | None

pPos: int | None

showAsCaption: bool | None

showCell: bool | None

showTip: bool | None

tagname = 'mps'

class fastpyxl.pivot.table.PageField(fld=None, item=None, hier=None, name=None, cap=None, extLst=None)

Bases: Serialisable

cap: str | None

extLst: ExtensionList | None

fld: int | None

hier: int | None

item: int | None

name: str | None

tagname = 'pageField'

xml_order = ()

class fastpyxl.pivot.table.PivotArea(references=(), extLst=None, field=None, type='normal', dataOnly=True, labelOnly=None, grandRow=None, grandCol=None, cacheIndex=None, outline=True, offset=None, collapsedLevelsAreSubtotals=None, axis=None, fieldPosition=None)

Bases: Serialisable

axis: str | None

cacheIndex: bool | None

collapsedLevelsAreSubtotals: bool | None

dataOnly: bool | None

extLst: ExtensionList | None

field: int | None

fieldPosition: int | None

grandCol: bool | None

grandRow: bool | None

labelOnly: bool | None

offset: str | None

outline: bool | None

references: list[Reference]

tagname = 'pivotArea'

type: str | None

xml_order = ('references',)

class fastpyxl.pivot.table.PivotField(items=(), autoSortScope=None, name=None, axis=None, dataField=None, subtotalCaption=None, showDropDowns=True, hiddenLevel=None, uniqueMemberProperty=None, compact=True, allDrilled=None, numFmtId=None, outline=True, subtotalTop=True, dragToRow=True, dragToCol=True, multipleItemSelectionAllowed=None, dragToPage=True, dragToData=True, dragOff=True, showAll=True, insertBlankRow=None, serverField=None, insertPageBreak=None, autoShow=None, topAutoShow=True, hideNewItems=None, measureFilter=None, includeNewItemsInFilter=None, itemPageCount=10, sortType='manual', dataSourceSort=None, nonAutoSortDefault=None, rankBy=None, defaultSubtotal=True, sumSubtotal=None, countASubtotal=None, avgSubtotal=None, maxSubtotal=None, minSubtotal=None, productSubtotal=None, countSubtotal=None, stdDevSubtotal=None, stdDevPSubtotal=None, varSubtotal=None, varPSubtotal=None, showPropCell=None, showPropTip=None, showPropAsCaption=None, defaultAttributeDrillState=None, extLst=None)

Bases: Serialisable

allDrilled: bool | None

autoShow: bool | None

autoSortScope: AutoSortScope | None

avgSubtotal: bool | None

axis: str | None

compact: bool | None

countASubtotal: bool | None

countSubtotal: bool | None

dataField: bool | None

dataSourceSort: bool | None

defaultAttributeDrillState: bool | None

defaultSubtotal: bool | None

dragOff: bool | None

dragToCol: bool | None

dragToData: bool | None

dragToPage: bool | None

dragToRow: bool | None

extLst: ExtensionList | None

hiddenLevel: bool | None

hideNewItems: bool | None

includeNewItemsInFilter: bool | None

insertBlankRow: bool | None

insertPageBreak: bool | None

itemPageCount: int | None

items: list[FieldItem]

maxSubtotal: bool | None

measureFilter: bool | None

minSubtotal: bool | None

multipleItemSelectionAllowed: bool | None

name: str | None

nonAutoSortDefault: bool | None

numFmtId: int | None

outline: bool | None

productSubtotal: bool | None

rankBy: int | None

serverField: bool | None

showAll: bool | None

showDropDowns: bool | None

showPropAsCaption: bool | None

showPropCell: bool | None

showPropTip: bool | None

sortType: str | None

stdDevPSubtotal: bool | None

stdDevSubtotal: bool | None

subtotalCaption: str | None

subtotalTop: bool | None

sumSubtotal: bool | None

tagname = 'pivotField'

topAutoShow: bool | None

uniqueMemberProperty: str | None

varPSubtotal: bool | None

varSubtotal: bool | None

xml_order = ('items', 'autoSortScope')

class fastpyxl.pivot.table.PivotFilter(fld=None, mpFld=None, type=None, evalOrder=None, id=None, iMeasureHier=None, iMeasureFld=None, name=None, description=None, stringValue1=None, stringValue2=None, autoFilter=None, extLst=None)

Bases: Serialisable

autoFilter: AutoFilter | None

description: str | None

evalOrder: int | None

extLst: ExtensionList | None

fld: int | None

iMeasureFld: int | None

iMeasureHier: int | None

id: int | None

mpFld: int | None

name: str | None

stringValue1: str | None

stringValue2: str | None

tagname = 'filter'

type: str | None

xml_order = ('autoFilter',)

class fastpyxl.pivot.table.PivotFilters(count=None, filter=None)

Bases: Serialisable

property count

filter: PivotFilter | None

tagname = 'filters'

xml_order = ('filter',)

class fastpyxl.pivot.table.PivotHierarchy(outline=None, multipleItemSelectionAllowed=None, subtotalTop=None, showInFieldList=None, dragToRow=None, dragToCol=None, dragToPage=None, dragToData=None, dragOff=None, includeNewItemsInFilter=None, caption=None, mps=(), members=None, extLst=None)

Bases: Serialisable

caption: str | None

dragOff: bool | None

dragToCol: bool | None

dragToData: bool | None

dragToPage: bool | None

dragToRow: bool | None

extLst: ExtensionList | None

includeNewItemsInFilter: bool | None

members: MemberList | None

mps: list[MemberProperty]

multipleItemSelectionAllowed: bool | None

outline: bool | None

showInFieldList: bool | None

subtotalTop: bool | None

tagname = 'pivotHierarchy'

xml_order = ('mps', 'members')

class fastpyxl.pivot.table.PivotTableStyle(name=None, showRowHeaders=False, showColHeaders=False, showRowStripes=False, showColStripes=False, showLastColumn=False)

Bases: Serialisable

name: str | None

showColHeaders: bool | None

showColStripes: bool | None

showLastColumn: bool | None

showRowHeaders: bool | None

showRowStripes: bool | None

tagname = 'pivotTableStyleInfo'

class fastpyxl.pivot.table.Reference(field=None, count=None, selected=None, byPosition=None, relative=None, defaultSubtotal=None, sumSubtotal=None, countASubtotal=None, avgSubtotal=None, maxSubtotal=None, minSubtotal=None, productSubtotal=None, countSubtotal=None, stdDevSubtotal=None, stdDevPSubtotal=None, varSubtotal=None, varPSubtotal=None, x=(), extLst=None)

Bases: Serialisable

avgSubtotal: bool | None

byPosition: bool | None

property count

countASubtotal: bool | None

countSubtotal: bool | None

defaultSubtotal: bool | None

extLst: ExtensionList | None

field: int | None

maxSubtotal: bool | None

minSubtotal: bool | None

productSubtotal: bool | None

relative: bool | None

selected: bool | None

stdDevPSubtotal: bool | None

stdDevSubtotal: bool | None

sumSubtotal: bool | None

tagname = 'reference'

varPSubtotal: bool | None

varSubtotal: bool | None

x: list[int]

xml_order = ('x',)

class fastpyxl.pivot.table.RowColField(x=None)

Bases: Serialisable

tagname = 'field'

x: int | None

class fastpyxl.pivot.table.RowColItem(t='data', r=0, i=0, x=())

Bases: Serialisable

i: int | None

r: int | None

t: str | None

tagname = 'i'

x: list[int]

xml_order = ('x',)

class fastpyxl.pivot.table.RowHierarchiesUsage(count=None, rowHierarchyUsage=())

Bases: Serialisable

property count

rowHierarchyUsage: list[HierarchyUsage]

tagname = 'rowHierarchiesUsage'

xml_order = ('rowHierarchyUsage',)

class fastpyxl.pivot.table.TableDefinition(name=None, cacheId=None, dataOnRows=False, dataPosition=None, dataCaption=None, grandTotalCaption=None, errorCaption=None, showError=False, missingCaption=None, showMissing=True, pageStyle=None, pivotTableStyle=None, vacatedStyle=None, tag=None, updatedVersion=0, minRefreshableVersion=0, asteriskTotals=False, showItems=True, editData=False, disableFieldList=False, showCalcMbrs=True, visualTotals=True, showMultipleLabel=True, showDataDropDown=True, showDrill=True, printDrill=False, showMemberPropertyTips=True, showDataTips=True, enableWizard=True, enableDrill=True, enableFieldProperties=True, preserveFormatting=True, useAutoFormatting=False, pageWrap=0, pageOverThenDown=False, subtotalHiddenItems=False, rowGrandTotals=True, colGrandTotals=True, fieldPrintTitles=False, itemPrintTitles=False, mergeItem=False, showDropZones=True, createdVersion=0, indent=1, showEmptyRow=False, showEmptyCol=False, showHeaders=True, compact=True, outline=False, outlineData=False, compactData=True, published=False, gridDropZones=False, immersive=True, multipleFieldFilters=False, chartFormat=0, rowHeaderCaption=None, colHeaderCaption=None, fieldListSortAscending=False, mdxSubqueries=False, customListSort=None, autoFormatId=None, applyNumberFormats=False, applyBorderFormats=False, applyFontFormats=False, applyPatternFormats=False, applyAlignmentFormats=False, applyWidthHeightFormats=False, location=None, pivotFields=(), rowFields=(), rowItems=(), colFields=(), colItems=(), pageFields=(), dataFields=(), formats=(), conditionalFormats=None, chartFormats=(), pivotHierarchies=(), pivotTableStyleInfo=None, filters=(), rowHierarchiesUsage=None, colHierarchiesUsage=None, extLst=None, id=None)

Bases: Serialisable

applyAlignmentFormats: bool | None

applyBorderFormats: bool | None

applyFontFormats: bool | None

applyNumberFormats: bool | None

applyPatternFormats: bool | None

applyWidthHeightFormats: bool | None

asteriskTotals: bool | None

autoFormatId: int | None

cache = None

cacheId: int | None

chartFormat: int | None

chartFormats: list[ChartFormat]

colFields: list[RowColField]

colGrandTotals: bool | None

colHeaderCaption: str | None

colHierarchiesUsage: ColHierarchiesUsage | None

colItems: list[RowColItem]

compact: bool | None

compactData: bool | None

conditionalFormats: ConditionalFormatList | None

createdVersion: int | None

customListSort: bool | None

dataCaption: str | None

dataFields: list[DataField]

dataOnRows: bool | None

dataPosition: int | None

disableFieldList: bool | None

editData: bool | None

enableDrill: bool | None

enableFieldProperties: bool | None

enableWizard: bool | None

errorCaption: str | None

extLst: ExtensionList | None

fieldListSortAscending: bool | None

fieldPrintTitles: bool | None

filters: list[PivotFilter]

formats: list[Format]

formatted_fields()

Map fields to associated conditional formats by priority

grandTotalCaption: str | None

gridDropZones: bool | None

id: str | None

immersive: bool | None

indent: int | None

itemPrintTitles: bool | None

location: Location | None

mdxSubqueries: bool | None

mergeItem: bool | None

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

minRefreshableVersion: int | None

missingCaption: str | None

multipleFieldFilters: bool | None

name: str | None

outline: bool | None

outlineData: bool | None

pageFields: list[PageField]

pageOverThenDown: bool | None

pageStyle: str | None

pageWrap: int | None

property path

pivotFields: list[PivotField]

pivotHierarchies: list[PivotHierarchy]

pivotTableStyle: str | None

pivotTableStyleInfo: PivotTableStyle | None

preserveFormatting: bool | None

printDrill: bool | None

published: bool | None

rel_type = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotTable'

rowFields: list[RowColField]

rowGrandTotals: bool | None

rowHeaderCaption: str | None

rowHierarchiesUsage: RowHierarchiesUsage | None

rowItems: list[RowColItem]

showCalcMbrs: bool | None

showDataDropDown: bool | None

showDataTips: bool | None

showDrill: bool | None

showDropZones: bool | None

showEmptyCol: bool | None

showEmptyRow: bool | None

showError: bool | None

showHeaders: bool | None

showItems: bool | None

showMemberPropertyTips: bool | None

showMissing: bool | None

showMultipleLabel: bool | None

subtotalHiddenItems: bool | None

property summary

Provide a simplified summary of the table

tag: str | None

tagname = 'pivotTableDefinition'

to_tree()

updatedVersion: int | None

useAutoFormatting: bool | None

vacatedStyle: str | None

visualTotals: bool | None

xml_order = ('location', 'pivotFields', 'rowFields', 'rowItems', 'colFields', 'colItems', 'pageFields', 'dataFields', 'formats', 'conditionalFormats', 'chartFormats', 'pivotHierarchies', 'pivotTableStyleInfo', 'filters', 'rowHierarchiesUsage', 'colHierarchiesUsage')