Documentation

Column
in package

Table of Contents

Properties

$columnFormula  : string|null
Column Formula.
$columnIndex  : string
Table Column Index.
$showFilterButton  : bool
Show Filter Button.
$table  : Table|null
Table.
$totalsRowFormula  : string|null
Total Row Formula.
$totalsRowFunction  : string|null
Total Row Function.
$totalsRowLabel  : string|null
Total Row Label.

Methods

__construct()  : mixed
Create a new Column.
getColumnFormula()  : string|null
Get column Formula.
getColumnIndex()  : string
Get Table column index as string eg: 'A'.
getShowFilterButton()  : bool
Get show Filter Button.
getTable()  : Table|null
Get this Column's Table.
getTotalsRowFormula()  : string|null
Get total Row Formula.
getTotalsRowFunction()  : string|null
Get total Row Function.
getTotalsRowLabel()  : string|null
Get total Row Label.
setColumnFormula()  : self
Set column Formula.
setColumnIndex()  : self
Set Table column index as string eg: 'A'.
setShowFilterButton()  : self
Set show Filter Button.
setTable()  : self
Set this Column's Table.
setTotalsRowFormula()  : self
Set total Row Formula.
setTotalsRowFunction()  : self
Set total Row Function.
setTotalsRowLabel()  : self
Set total Row Label.
updateStructuredReferences()  : void
updateStructuredReferencesInCells()  : void
updateStructuredReferencesInNamedFormulae()  : void

Properties

$columnFormula

Column Formula.

private string|null $columnFormula = null

$columnIndex

Table Column Index.

private string $columnIndex

$showFilterButton

Show Filter Button.

private bool $showFilterButton = true

$totalsRowFormula

Total Row Formula.

private string|null $totalsRowFormula = null

$totalsRowFunction

Total Row Function.

private string|null $totalsRowFunction = null

$totalsRowLabel

Total Row Label.

private string|null $totalsRowLabel = null

Methods

__construct()

Create a new Column.

public __construct(string $column[, Table|null $table = null ]) : mixed
Parameters
$column : string

Column (e.g. A)

$table : Table|null = null

Table for this column

getColumnFormula()

Get column Formula.

public getColumnFormula() : string|null
Return values
string|null

getColumnIndex()

Get Table column index as string eg: 'A'.

public getColumnIndex() : string
Return values
string

getShowFilterButton()

Get show Filter Button.

public getShowFilterButton() : bool
Return values
bool

getTable()

Get this Column's Table.

public getTable() : Table|null
Return values
Table|null

getTotalsRowFormula()

Get total Row Formula.

public getTotalsRowFormula() : string|null
Return values
string|null

getTotalsRowFunction()

Get total Row Function.

public getTotalsRowFunction() : string|null
Return values
string|null

getTotalsRowLabel()

Get total Row Label.

public getTotalsRowLabel() : string|null
Return values
string|null

setColumnFormula()

Set column Formula.

public setColumnFormula(string $columnFormula) : self
Parameters
$columnFormula : string
Return values
self

setColumnIndex()

Set Table column index as string eg: 'A'.

public setColumnIndex(string $column) : self
Parameters
$column : string

Column (e.g. A)

Return values
self

setShowFilterButton()

Set show Filter Button.

public setShowFilterButton(bool $showFilterButton) : self
Parameters
$showFilterButton : bool
Return values
self

setTable()

Set this Column's Table.

public setTable([Table|null $table = null ]) : self
Parameters
$table : Table|null = null
Return values
self

setTotalsRowFormula()

Set total Row Formula.

public setTotalsRowFormula(string $totalsRowFormula) : self
Parameters
$totalsRowFormula : string
Return values
self

setTotalsRowFunction()

Set total Row Function.

public setTotalsRowFunction(string $totalsRowFunction) : self
Parameters
$totalsRowFunction : string
Return values
self

setTotalsRowLabel()

Set total Row Label.

public setTotalsRowLabel(string $totalsRowLabel) : self
Parameters
$totalsRowLabel : string
Return values
self

updateStructuredReferences()

public static updateStructuredReferences(Worksheet|null $workSheet, string|null $oldTitle, string|null $newTitle) : void
Parameters
$workSheet : Worksheet|null
$oldTitle : string|null
$newTitle : string|null

updateStructuredReferencesInCells()

private static updateStructuredReferencesInCells(Worksheet $worksheet, string $oldTitle, string $newTitle) : void
Parameters
$worksheet : Worksheet
$oldTitle : string
$newTitle : string

updateStructuredReferencesInNamedFormulae()

private static updateStructuredReferencesInNamedFormulae(Spreadsheet $spreadsheet, string $oldTitle, string $newTitle) : void
Parameters
$spreadsheet : Spreadsheet
$oldTitle : string
$newTitle : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results