Documentation

Font extends Supervisor

in package

• Application

Table of Contents

Constants

CAP_ALL  = 'all'

CAP_NONE  = 'none'

CAP_SMALL  = 'small'

DEFAULT_FONT_NAME  = 'Calibri'

UNDERLINE_DOUBLE  = 'double'

UNDERLINE_DOUBLEACCOUNTING  = 'doubleAccounting'

UNDERLINE_NONE  = 'none'

UNDERLINE_SINGLE  = 'single'

UNDERLINE_SINGLEACCOUNTING  = 'singleAccounting'

VALID_CAPS  = [self::CAP_ALL, self::CAP_SMALL, self::CAP_NONE]

Properties

$colorIndex  : int|null

$bold  : bool|null

Bold.

$cap  : string|null

$color  : Color

Foreground color.

$isSupervisor  : bool

Supervisor?

$italic  : bool|null

Italic.

$name  : string|null

Font Name.

$parent  : Spreadsheet|Supervisor

Parent. Only used for supervisor.

$parentPropertyName  : string|null

Parent property name.

$scheme  : string

$size  : float|null

Font Size.

$strikethrough  : bool|null

Strikethrough.

$subscript  : bool|null

Subscript.

$superscript  : bool|null

Superscript.

$underline  : string|null

Underline.

$baseLine  : int

$chartColor  : ChartColor|null

$complexScript  : string

$eastAsian  : string

$latin  : string

The following 7 are used only for chart titles, I think.

$strikeType  : string

$underlineColor  : ChartColor|null

Methods

__clone()  : mixed

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

__construct()  : mixed

Create a new Font.

applyFromArray()  : $this

Apply styles from array.

bindParent()  : $this

Bind parent. Only used for supervisor.

exportArray()  : array<string|int, mixed>

Export style as array.

getActiveCell()  : string

Get the currently active cell coordinate in currently active sheet.

getActiveSheet()  : Worksheet

Get the currently active sheet. Only used for supervisor.

getBaseLine()  : int

getBold()  : bool|null

Get Bold.

getCap()  : string|null

getChartColor()  : ChartColor|null

getColor()  : Color

Get Color.

getComplexScript()  : string

getEastAsian()  : string

getHashCode()  : string

Get hash code.

getIsSupervisor()  : bool

Is this a supervisor or a cell style component?

getItalic()  : bool|null

Get Italic.

getLatin()  : string

getName()  : string|null

Get Name.

getScheme()  : string

getSelectedCells()  : string

Get the currently active cell coordinate in currently active sheet.

getSharedComponent()  : self

Get the shared style component for the currently active cell in currently active sheet.

getSize()  : float|null

Get Size.

getStrikethrough()  : bool|null

Get Strikethrough.

getStrikeType()  : string

getStyleArray()  : array<string|int, mixed>

Build style array from subcomponents.

getSubscript()  : bool|null

Get Subscript.

getSuperscript()  : bool|null

Get Superscript.

getUnderline()  : string|null

Get Underline.

getUnderlineColor()  : ChartColor|null

setBaseLine()  : self

setBold()  : $this

Set Bold.

setCap()  : self

Set capitalization attribute. If not one of the permitted values (all, small, or none), set it to null.

setChartColor()  : self

setChartColorFromObject()  : self

setColor()  : $this

Set Color.

setComplexScript()  : self

setEastAsian()  : self

setItalic()  : $this

Set Italic.

setLatin()  : self

setName()  : self

Set Name and turn off Scheme.

setScheme()  : self

setSize()  : $this

Set Size.

setStrikethrough()  : $this

Set Strikethrough.

setStrikeType()  : self

setSubscript()  : $this

Set Subscript.

setSuperscript()  : $this

Set Superscript.

setUnderline()  : $this

Set Underline.

setUnderlineColor()  : self

exportArray1()  : array<string|int, mixed>

Abstract method to be implemented in anything which extends this class.

exportArray2()  : void

Populate array from exportArray1.

hashChartColor()  : string