PivotTable
in package
Generates the OOXML parts for a pivot table that was built in memory.
The parts are written with refreshOnLoad set on the cache definition, so the spreadsheet application computes the actual value cells (and expands the axis items) when the workbook is opened. This keeps the generated XML small and avoids having to replicate the aggregation engine.
Table of Contents
Methods
- writeCacheDefinition() : string
- Build the pivotCacheDefinition part, referencing its records by rel id.
- writeCacheRecords() : string
- Build the (empty) pivotCacheRecords part. Records are regenerated by the spreadsheet application on refresh.
- writeCacheRelationships() : string
- Rels for the cache definition part -> its records.
- writeDefinition() : string
- Build the pivotTableDefinition part.
- writeTableRelationships() : string
- Rels for the pivot table part -> its cache definition.
Methods
writeCacheDefinition()
Build the pivotCacheDefinition part, referencing its records by rel id.
public
static writeCacheDefinition(PivotTable $pivotTable) : string
Parameters
- $pivotTable : PivotTable
Return values
stringwriteCacheRecords()
Build the (empty) pivotCacheRecords part. Records are regenerated by the spreadsheet application on refresh.
public
static writeCacheRecords() : string
Return values
stringwriteCacheRelationships()
Rels for the cache definition part -> its records.
public
static writeCacheRelationships(int $cacheIndex) : string
Parameters
- $cacheIndex : int
Return values
stringwriteDefinition()
Build the pivotTableDefinition part.
public
static writeDefinition(PivotTable $pivotTable, int $cacheId) : string
Parameters
- $pivotTable : PivotTable
- $cacheId : int
-
the workbook-level cache id referenced by this table
Return values
stringwriteTableRelationships()
Rels for the pivot table part -> its cache definition.
public
static writeTableRelationships(int $cacheIndex) : string
Parameters
- $cacheIndex : int