Properties

$includeCharts

$includeCharts : boolean

Write charts that are defined in the workbook? Identifies whether the Writer should write definitions for any charts that exist in the PhpSpreadsheet object;.

Type

boolean

$preCalculateFormulas

$preCalculateFormulas : boolean

Pre-calculate formulas Forces PhpSpreadsheet to recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file.

Type

boolean

$useDiskCaching

$useDiskCaching : boolean

Use disk caching where possible?

Type

boolean

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory.

Type

string

$strTotal

$strTotal : integer

Total number of shared strings in workbook.

Type

integer

$strUnique

$strUnique : integer

Number of unique shared strings in workbook.

Type

integer

$strTable

$strTable : array

Array of unique shared strings in workbook.

Type

array

$colors

$colors : array

Color cache. Mapping between RGB value and color index.

Type

array

$IDCLs

$IDCLs : array

Identifier clusters for drawings. Used in MSODRAWINGGROUP record.

Type

array

$summaryInformation

$summaryInformation : array

Basic OLE object summary information.

Type

array

$documentSummaryInformation

$documentSummaryInformation : array

Extended OLE object document summary information.

Type

array

Methods

getIncludeCharts()

getIncludeCharts() : boolean

Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object.

If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.

Set to false (the default) to ignore charts.

Parameters

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getPreCalculateFormulas()

getPreCalculateFormulas() : boolean

Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. This is faster for saving in PhpSpreadsheet, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.

Returns

boolean

setPreCalculateFormulas()

setPreCalculateFormulas(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save.

Parameters

boolean $pValue

Pre-Calculate Formulas?

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getUseDiskCaching()

getUseDiskCaching() : boolean

Get use disk caching where possible?

Returns

boolean

setUseDiskCaching()

setUseDiskCaching(boolean  $pValue, string  $pDirectory = null) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set use disk caching where possible?

Parameters

boolean $pValue
string $pDirectory

Disk caching directory

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

when directory does not exist

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory.

Returns

string

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) 

Create a new Xls Writer.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

PhpSpreadsheet object

save()

save(string  $pFilename) 

Save Spreadsheet to file.

Parameters

string $pFilename

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

buildWorksheetEschers()

buildWorksheetEschers() 

Build the Worksheet Escher objects.

buildWorkbookEscher()

buildWorkbookEscher() 

Build the Escher object corresponding to the MSODRAWINGGROUP record.

writeDocumentSummaryInformation()

writeDocumentSummaryInformation() : string

Build the OLE Part for DocumentSummary Information.

Returns

string

writeSummaryInformation()

writeSummaryInformation() : string

Build the OLE Part for Summary Information.

Returns

string