Constants

HORIZONTAL_GENERAL

HORIZONTAL_GENERAL = 'general'

HORIZONTAL_LEFT

HORIZONTAL_LEFT = 'left'

HORIZONTAL_RIGHT

HORIZONTAL_RIGHT = 'right'

HORIZONTAL_CENTER

HORIZONTAL_CENTER = 'center'

HORIZONTAL_CENTER_CONTINUOUS

HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous'

HORIZONTAL_JUSTIFY

HORIZONTAL_JUSTIFY = 'justify'

HORIZONTAL_FILL

HORIZONTAL_FILL = 'fill'

HORIZONTAL_DISTRIBUTED

HORIZONTAL_DISTRIBUTED = 'distributed'

VERTICAL_BOTTOM

VERTICAL_BOTTOM = 'bottom'

VERTICAL_TOP

VERTICAL_TOP = 'top'

VERTICAL_CENTER

VERTICAL_CENTER = 'center'

VERTICAL_JUSTIFY

VERTICAL_JUSTIFY = 'justify'

VERTICAL_DISTRIBUTED

VERTICAL_DISTRIBUTED = 'distributed'

READORDER_CONTEXT

READORDER_CONTEXT = 0

READORDER_LTR

READORDER_LTR = 1

READORDER_RTL

READORDER_RTL = 2

TEXTROTATION_STACK_EXCEL

TEXTROTATION_STACK_EXCEL = 255

TEXTROTATION_STACK_PHPSPREADSHEET

TEXTROTATION_STACK_PHPSPREADSHEET = -165

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

Parent. Only used for supervisor.

Type

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$horizontal

$horizontal : string

Horizontal alignment.

Type

string

$vertical

$vertical : string

Vertical alignment.

Type

string

$textRotation

$textRotation : integer

Text rotation.

Type

integer

$wrapText

$wrapText : boolean

Wrap text.

Type

boolean

$shrinkToFit

$shrinkToFit : boolean

Shrink to fit.

Type

boolean

$indent

$indent : integer

Indent - only possible with horizontal alignment left and right.

Type

integer

$readOrder

$readOrder : integer

Read order.

Type

integer

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new Alignment.

Parameters

boolean $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

boolean $isConditional

Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style  $parent, null|string  $parentPropertyName = null) : $this

Bind parent. Only used for supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style $parent
null|string $parentPropertyName

Returns

$this

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get the currently active sheet. Only used for supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

__clone()

__clone() 

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

exportArray()

exportArray() 

Export style as array.

Available to anything which extends this class: Alignment, Border, Borders, Color, Fill, Font, NumberFormat, Protection, and Style.

getSharedComponent()

getSharedComponent() : \PhpOffice\PhpSpreadsheet\Style\Alignment

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Alignment

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles) : $this

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray( [ 'horizontal' => \PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_CENTER, 'vertical' => \PhpOffice\PhpSpreadsheet\Style\Alignment::VERTICAL_CENTER, 'textRotation' => 0, 'wrapText' => TRUE ] );

Parameters

array $pStyles

Array containing style information

Returns

$this

getHorizontal()

getHorizontal() : string

Get Horizontal.

Returns

string

setHorizontal()

setHorizontal(string  $pValue) : $this

Set Horizontal.

Parameters

string $pValue

see self::HORIZONTAL_*

Returns

$this

getVertical()

getVertical() : string

Get Vertical.

Returns

string

setVertical()

setVertical(string  $pValue) : $this

Set Vertical.

Parameters

string $pValue

see self::VERTICAL_*

Returns

$this

getTextRotation()

getTextRotation() : integer

Get TextRotation.

Returns

integer

setTextRotation()

setTextRotation(integer  $pValue) : $this

Set TextRotation.

Parameters

integer $pValue

Returns

$this

getWrapText()

getWrapText() : boolean

Get Wrap Text.

Returns

boolean

setWrapText()

setWrapText(boolean  $pValue) : $this

Set Wrap Text.

Parameters

boolean $pValue

Returns

$this

getShrinkToFit()

getShrinkToFit() : boolean

Get Shrink to fit.

Returns

boolean

setShrinkToFit()

setShrinkToFit(boolean  $pValue) : $this

Set Shrink to fit.

Parameters

boolean $pValue

Returns

$this

getIndent()

getIndent() : integer

Get indent.

Returns

integer

setIndent()

setIndent(integer  $pValue) : $this

Set indent.

Parameters

integer $pValue

Returns

$this

getReadOrder()

getReadOrder() : integer

Get read order.

Returns

integer

setReadOrder()

setReadOrder(integer  $pValue) : $this

Set read order.

Parameters

integer $pValue

Returns

$this

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

exportArray1()

exportArray1() 

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

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

exportArray2()

exportArray2(array  $exportedArray, \PhpOffice\PhpSpreadsheet\Style\string  $index, mixed  $objOrValue) 

Populate array from exportArray1.

This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.

Parameters

array $exportedArray
\PhpOffice\PhpSpreadsheet\Style\string $index
mixed $objOrValue