Documentation

Title
in package

Table of Contents

Constants

TITLE_CELL_REFERENCE  = '/^(.*)!' . '[$]([A-Z]{1,3})' . '[$](\d{1,7})$/i'

Properties

$caption  : array<string|int, RichText|string>|RichText|string
Title Caption.
$cellReference  : string
$font  : Font|null
$layout  : Layout|null
Title Layout.
$overlay  : bool
Allow overlay of other elements?

Methods

__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new Title.
getCalculatedTitle()  : string|null
getCaption()  : array<string|int, RichText|string>|RichText|string
Get caption.
getCaptionText()  : string
getCellReference()  : string
getFont()  : Font|null
getLayout()  : Layout|null
getOverlay()  : bool
Get allow overlay of other elements?
setCaption()  : $this
Set caption.
setCellReference()  : self
setFont()  : self
setOverlay()  : self
Set allow overlay of other elements?

Constants

TITLE_CELL_REFERENCE

public mixed TITLE_CELL_REFERENCE = '/^(.*)!' . '[$]([A-Z]{1,3})' . '[$](\d{1,7})$/i'

Properties

$cellReference

private string $cellReference = ''

$overlay

Allow overlay of other elements?

private bool $overlay = true

Methods

__clone()

Implement PHP __clone to create a deep clone, not just a shallow copy.

public __clone() : mixed

__construct()

Create a new Title.

public __construct([array<string|int, RichText|string>|RichText|string $caption = '' ][, Layout|null $layout = null ][, bool $overlay = false ]) : mixed
Parameters
$caption : array<string|int, RichText|string>|RichText|string = ''
$layout : Layout|null = null
$overlay : bool = false

getCalculatedTitle()

public getCalculatedTitle(Spreadsheet|null $spreadsheet) : string|null
Parameters
$spreadsheet : Spreadsheet|null
Return values
string|null

getCaptionText()

public getCaptionText([Spreadsheet|null $spreadsheet = null ]) : string
Parameters
$spreadsheet : Spreadsheet|null = null
Return values
string

getCellReference()

public getCellReference() : string
Return values
string

getOverlay()

Get allow overlay of other elements?

public getOverlay() : bool
Return values
bool

setCaption()

Set caption.

public setCaption(array<string|int, RichText|string>|RichText|string $caption) : $this
Parameters
$caption : array<string|int, RichText|string>|RichText|string
Return values
$this

setCellReference()

public setCellReference(string $cellReference) : self
Parameters
$cellReference : string
Return values
self

setFont()

public setFont(Font|null $font) : self
Parameters
$font : Font|null
Return values
self

setOverlay()

Set allow overlay of other elements?

public setOverlay(bool $overlay) : self
Parameters
$overlay : bool
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results