Documentation

Alignment extends Supervisor

in package

• Application

Table of Contents

Constants

HORIZONTAL_ALIGNMENT_FOR_HTML  = [ self::HORIZONTAL_LEFT => self::HORIZONTAL_LEFT, self::HORIZONTAL_RIGHT => self::HORIZONTAL_RIGHT, self::HORIZONTAL_CENTER => self::HORIZONTAL_CENTER, self::HORIZONTAL_CENTER_CONTINUOUS => self::HORIZONTAL_CENTER, self::HORIZONTAL_JUSTIFY => self::HORIZONTAL_JUSTIFY, //self::HORIZONTAL_FILL => self::HORIZONTAL_FILL, // no reasonable equivalent for fill self::HORIZONTAL_DISTRIBUTED => self::HORIZONTAL_JUSTIFY, ]

HORIZONTAL_ALIGNMENT_FOR_XLSX  = [self::HORIZONTAL_LEFT => self::HORIZONTAL_LEFT, self::HORIZONTAL_RIGHT => self::HORIZONTAL_RIGHT, self::HORIZONTAL_CENTER => self::HORIZONTAL_CENTER, self::HORIZONTAL_CENTER_CONTINUOUS => self::HORIZONTAL_CENTER_CONTINUOUS, self::HORIZONTAL_JUSTIFY => self::HORIZONTAL_JUSTIFY, self::HORIZONTAL_FILL => self::HORIZONTAL_FILL, self::HORIZONTAL_DISTRIBUTED => self::HORIZONTAL_DISTRIBUTED]

HORIZONTAL_CENTER  = 'center'

HORIZONTAL_CENTER_CONTINUOUS  = 'centerContinuous'

HORIZONTAL_DISTRIBUTED  = 'distributed'

HORIZONTAL_FILL  = 'fill'

HORIZONTAL_GENERAL  = 'general'

HORIZONTAL_JUSTIFY  = 'justify'

HORIZONTAL_LEFT  = 'left'

HORIZONTAL_RIGHT  = 'right'

READORDER_CONTEXT  = 0

READORDER_LTR  = 1

READORDER_RTL  = 2

TEXTROTATION_STACK_EXCEL  = 255

TEXTROTATION_STACK_PHPSPREADSHEET  = -165

VERTICAL_ALIGNMENT_FOR_HTML  = [ self::VERTICAL_BOTTOM => self::VERTICAL_BOTTOM, self::VERTICAL_TOP => self::VERTICAL_TOP, self::VERTICAL_CENTER => self::VERTICAL_MIDDLE, self::VERTICAL_JUSTIFY => self::VERTICAL_MIDDLE, self::VERTICAL_DISTRIBUTED => self::VERTICAL_MIDDLE, // css settings that arent't in sync with Excel self::VERTICAL_BASELINE => self::VERTICAL_BASELINE, self::VERTICAL_MIDDLE => self::VERTICAL_MIDDLE, self::VERTICAL_SUB => self::VERTICAL_SUB, self::VERTICAL_SUPER => self::VERTICAL_SUPER, self::VERTICAL_TEXT_BOTTOM => self::VERTICAL_TEXT_BOTTOM, self::VERTICAL_TEXT_TOP => self::VERTICAL_TEXT_TOP, ]

VERTICAL_ALIGNMENT_FOR_XLSX  = [ self::VERTICAL_BOTTOM => self::VERTICAL_BOTTOM, self::VERTICAL_TOP => self::VERTICAL_TOP, self::VERTICAL_CENTER => self::VERTICAL_CENTER, self::VERTICAL_JUSTIFY => self::VERTICAL_JUSTIFY, self::VERTICAL_DISTRIBUTED => self::VERTICAL_DISTRIBUTED, // css settings that arent't in sync with Excel self::VERTICAL_BASELINE => self::VERTICAL_BOTTOM, self::VERTICAL_MIDDLE => self::VERTICAL_CENTER, self::VERTICAL_SUB => self::VERTICAL_BOTTOM, self::VERTICAL_SUPER => self::VERTICAL_TOP, self::VERTICAL_TEXT_BOTTOM => self::VERTICAL_BOTTOM, self::VERTICAL_TEXT_TOP => self::VERTICAL_TOP, ]

VERTICAL_BOTTOM  = 'bottom'

VERTICAL_CENTER  = 'center'

VERTICAL_DISTRIBUTED  = 'distributed'

VERTICAL_JUSTIFY  = 'justify'

VERTICAL_TOP  = 'top'

HORIZONTAL_CENTER_CONTINUOUS_LC  = 'centercontinuous'

VERTICAL_BASELINE  = 'baseline'

VERTICAL_MIDDLE  = 'middle'

VERTICAL_SUB  = 'sub'

VERTICAL_SUPER  = 'super'

VERTICAL_TEXT_BOTTOM  = 'text-bottom'

VERTICAL_TEXT_TOP  = 'text-top'

Properties

$horizontal  : string|null

Horizontal alignment.

$indent  : int

Indent - only possible with horizontal alignment left and right.

$isSupervisor  : bool

Supervisor?

$parent  : Spreadsheet|Supervisor

Parent. Only used for supervisor.

$parentPropertyName  : string|null

Parent property name.

$readOrder  : int

Read order.

$shrinkToFit  : bool

Shrink to fit.

$textRotation  : int|null

Text rotation.

$vertical  : string|null

Vertical alignment.

$wrapText  : bool

Wrap text.

Methods

__clone()  : mixed

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

__construct()  : mixed

Create a new Alignment.

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.

getHashCode()  : string

Get hash code.

getHorizontal()  : null|string

Get Horizontal.

getIndent()  : int

Get indent.

getIsSupervisor()  : bool

Is this a supervisor or a cell style component?

getReadOrder()  : int

Get read order.

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.

getShrinkToFit()  : bool

Get Shrink to fit.

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

Build style array from subcomponents.

getTextRotation()  : null|int

Get TextRotation.

getVertical()  : null|string

Get Vertical.

getWrapText()  : bool

Get Wrap Text.

setHorizontal()  : $this

Set Horizontal.

setIndent()  : $this

Set indent.

setReadOrder()  : $this

Set read order.

setShrinkToFit()  : $this

Set Shrink to fit.

setTextRotation()  : $this

Set TextRotation.

setVertical()  : $this

Set Vertical.

setWrapText()  : $this

Set Wrap Text.

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

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

exportArray2()  : void

Populate array from exportArray1.