Paper Office
paper-xlsxAPI referencepivot.table

TableDefinition

paper-xlsx 0.2.1 API reference

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=None, chartFormat=0, rowHeaderCaption=None, colHeaderCaption=None, fieldListSortAscending=None, mdxSubqueries=None, 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)

Attributes

applyAlignmentFormats

attributeapplyAlignmentFormats
= applyAlignmentFormats

applyBorderFormats

attributeapplyBorderFormats
= applyBorderFormats

applyFontFormats

attributeapplyFontFormats
= applyFontFormats

applyNumberFormats

attributeapplyNumberFormats
= applyNumberFormats

applyPatternFormats

attributeapplyPatternFormats
= applyPatternFormats

applyWidthHeightFormats

attributeapplyWidthHeightFormats
= applyWidthHeightFormats

asteriskTotals

attributeasteriskTotals
= asteriskTotals

autoFormatId

attributeautoFormatId
= autoFormatId

cache

attributecache
= None

cacheId

attributecacheId
= cacheId

chartFormat

attributechartFormat
= chartFormat

chartFormats

attributechartFormats
= chartFormats

colFields

attributecolFields
= colFields

colGrandTotals

attributecolGrandTotals
= colGrandTotals

colHeaderCaption

attributecolHeaderCaption
= colHeaderCaption

colHierarchiesUsage

attributecolHierarchiesUsage
= colHierarchiesUsage

colItems

attributecolItems
= colItems

compact

attributecompact
= compact

compactData

attributecompactData
= compactData

conditionalFormats

attributeconditionalFormats
= None

createdVersion

attributecreatedVersion
= createdVersion

customListSort

attributecustomListSort
= customListSort

dataCaption

attributedataCaption
= dataCaption

dataFields

attributedataFields
= dataFields

dataOnRows

attributedataOnRows
= dataOnRows

dataPosition

attributedataPosition
= dataPosition

disableFieldList

attributedisableFieldList
= disableFieldList

editData

attributeeditData
= editData

enableDrill

attributeenableDrill
= enableDrill

enableFieldProperties

attributeenableFieldProperties
= enableFieldProperties

enableWizard

attributeenableWizard
= enableWizard

errorCaption

attributeerrorCaption
= errorCaption

extLst

attributeextLst
= extLst

fieldListSortAscending

attributefieldListSortAscending
= fieldListSortAscending

fieldPrintTitles

attributefieldPrintTitles
= fieldPrintTitles

filters

attributefilters
= filters

formats

attributeformats
= formats

grandTotalCaption

attributegrandTotalCaption
= grandTotalCaption

gridDropZones

attributegridDropZones
= gridDropZones

id

attributeid
= id

idx_base

attributeidx_base
= 0

immersive

attributeimmersive
= immersive

indent

attributeindent
= indent

itemPrintTitles

attributeitemPrintTitles
= itemPrintTitles

location

attributelocation
= location

mdxSubqueries

attributemdxSubqueries
= mdxSubqueries

mergeItem

attributemergeItem
= mergeItem

mime_type

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

minRefreshableVersion

attributeminRefreshableVersion
= minRefreshableVersion

missingCaption

attributemissingCaption
= missingCaption

multipleFieldFilters

attributemultipleFieldFilters
= multipleFieldFilters

name

attributename
= name

namespace

attributenamespace
= None

outline

attributeoutline
= outline

outlineData

attributeoutlineData
= outlineData

pageFields

attributepageFields
= pageFields

pageOverThenDown

attributepageOverThenDown
= pageOverThenDown

pageStyle

attributepageStyle
= pageStyle

pageWrap

attributepageWrap
= pageWrap

path

attributepath

pivotFields

attributepivotFields
= pivotFields

pivotHierarchies

attributepivotHierarchies
= pivotHierarchies

pivotTableStyle

attributepivotTableStyle
= pivotTableStyle

pivotTableStyleInfo

attributepivotTableStyleInfo
= pivotTableStyleInfo

preserveFormatting

attributepreserveFormatting
= preserveFormatting

printDrill

attributeprintDrill
= printDrill

published

attributepublished
= published

rel_type

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

rowFields

attributerowFields
= rowFields

rowGrandTotals

attributerowGrandTotals
= rowGrandTotals

rowHeaderCaption

attributerowHeaderCaption
= rowHeaderCaption

rowHierarchiesUsage

attributerowHierarchiesUsage
= rowHierarchiesUsage

rowItems

attributerowItems
= rowItems

showCalcMbrs

attributeshowCalcMbrs
= showCalcMbrs

showDataDropDown

attributeshowDataDropDown
= showDataDropDown

showDataTips

attributeshowDataTips
= showDataTips

showDrill

attributeshowDrill
= showDrill

showDropZones

attributeshowDropZones
= showDropZones

showEmptyCol

attributeshowEmptyCol
= showEmptyCol

showEmptyRow

attributeshowEmptyRow
= showEmptyRow

showError

attributeshowError
= showError

showHeaders

attributeshowHeaders
= showHeaders

showItems

attributeshowItems
= showItems

showMemberPropertyTips

attributeshowMemberPropertyTips
= showMemberPropertyTips

showMissing

attributeshowMissing
= showMissing

showMultipleLabel

attributeshowMultipleLabel
= showMultipleLabel

subtotalHiddenItems

attributesubtotalHiddenItems
= subtotalHiddenItems

summary

attributesummary

Provide a simplified summary of the table

tag

attributetag
= tag

tagname

attributetagname
= 'pivotTableDefinition'

updatedVersion

attributeupdatedVersion
= updatedVersion

useAutoFormatting

attributeuseAutoFormatting
= useAutoFormatting

vacatedStyle

attributevacatedStyle
= vacatedStyle

visualTotals

attributevisualTotals
= visualTotals

Functions

__iter__

func__iter__()

formatted_fields

funcformatted_fields()

Map fields to associated conditional formats by priority

from_tree

funcfrom_tree(node)

Create object from XML

paramnode

to_tree

functo_tree()

On this page