Constants

FILL_NONE

FILL_NONE = 'none'

FILL_SOLID

FILL_SOLID = 'solid'

FILL_GRADIENT_LINEAR

FILL_GRADIENT_LINEAR = 'linear'

FILL_GRADIENT_PATH

FILL_GRADIENT_PATH = 'path'

FILL_PATTERN_DARKDOWN

FILL_PATTERN_DARKDOWN = 'darkDown'

FILL_PATTERN_DARKGRAY

FILL_PATTERN_DARKGRAY = 'darkGray'

FILL_PATTERN_DARKGRID

FILL_PATTERN_DARKGRID = 'darkGrid'

FILL_PATTERN_DARKHORIZONTAL

FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal'

FILL_PATTERN_DARKTRELLIS

FILL_PATTERN_DARKTRELLIS = 'darkTrellis'

FILL_PATTERN_DARKUP

FILL_PATTERN_DARKUP = 'darkUp'

FILL_PATTERN_DARKVERTICAL

FILL_PATTERN_DARKVERTICAL = 'darkVertical'

FILL_PATTERN_GRAY0625

FILL_PATTERN_GRAY0625 = 'gray0625'

FILL_PATTERN_GRAY125

FILL_PATTERN_GRAY125 = 'gray125'

FILL_PATTERN_LIGHTDOWN

FILL_PATTERN_LIGHTDOWN = 'lightDown'

FILL_PATTERN_LIGHTGRAY

FILL_PATTERN_LIGHTGRAY = 'lightGray'

FILL_PATTERN_LIGHTGRID

FILL_PATTERN_LIGHTGRID = 'lightGrid'

FILL_PATTERN_LIGHTHORIZONTAL

FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal'

FILL_PATTERN_LIGHTTRELLIS

FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis'

FILL_PATTERN_LIGHTUP

FILL_PATTERN_LIGHTUP = 'lightUp'

FILL_PATTERN_LIGHTVERTICAL

FILL_PATTERN_LIGHTVERTICAL = 'lightVertical'

FILL_PATTERN_MEDIUMGRAY

FILL_PATTERN_MEDIUMGRAY = 'mediumGray'

Properties

$startcolorIndex

$startcolorIndex : integer

Type

integer

$endcolorIndex

$endcolorIndex : integer

Type

integer

$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

$fillType

$fillType : string

Fill type.

Type

string

$rotation

$rotation : float

Rotation.

Type

float

Methods

__construct()

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

Create a new Fill.

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.

getSharedComponent()

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

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Fill

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')->getFill()->applyFromArray( [ 'fillType' => Fill::FILL_GRADIENT_LINEAR, 'rotation' => 0, 'startColor' => [ 'rgb' => '000000' ], 'endColor' => [ 'argb' => 'FFFFFFFF' ] ] );

Parameters

array $pStyles

Array containing style information

Returns

$this

getFillType()

getFillType() : string

Get Fill Type.

Returns

string

setFillType()

setFillType(string  $pValue) : $this

Set Fill Type.

Parameters

string $pValue

Fill type, see self::FILL_*

Returns

$this

getRotation()

getRotation() : float

Get Rotation.

Returns

float

setRotation()

setRotation(float  $pValue) : $this

Set Rotation.

Parameters

float $pValue

Returns

$this

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code