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, mixed>|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
$caption
Title Caption.
private
array<string|int, RichText|string>|RichText|string
$caption
$cellReference
private
string
$cellReference
= ''
$font
private
Font|null
$font
= null
$layout
Title Layout.
private
Layout|null
$layout
$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, mixed>|RichText|string $caption = '' ][, Layout|null $layout = null ][, bool $overlay = false ]) : mixed
Parameters
getCalculatedTitle()
public
getCalculatedTitle(Spreadsheet|null $spreadsheet) : string|null
Parameters
- $spreadsheet : Spreadsheet|null
Return values
string|nullgetCaption()
Get caption.
public
getCaption() : array<string|int, mixed>|RichText|string
Return values
array<string|int, mixed>|RichText|stringgetCaptionText()
public
getCaptionText([Spreadsheet|null $spreadsheet = null ]) : string
Parameters
- $spreadsheet : Spreadsheet|null = null
Return values
stringgetCellReference()
public
getCellReference() : string
Return values
stringgetFont()
public
getFont() : Font|null
Return values
Font|nullgetLayout()
public
getLayout() : Layout|null
Return values
Layout|nullgetOverlay()
Get allow overlay of other elements?
public
getOverlay() : bool
Return values
boolsetCaption()
Set caption.
public
setCaption(array<string|int, mixed>|RichText|string $caption) : $this
Parameters
- $caption : array<string|int, mixed>|RichText|string
Return values
$thissetCellReference()
public
setCellReference(string $cellReference) : self
Parameters
- $cellReference : string
Return values
selfsetFont()
public
setFont(Font|null $font) : self
Parameters
- $font : Font|null
Return values
selfsetOverlay()
Set allow overlay of other elements?
public
setOverlay(bool $overlay) : self
Parameters
- $overlay : bool