Constants

NAMED_COLORS

NAMED_COLORS = array('Black', 'White', 'Red', 'Green', 'Blue', 'Yellow', 'Magenta', 'Cyan')

COLOR_BLACK

COLOR_BLACK = 'FF000000'

COLOR_WHITE

COLOR_WHITE = 'FFFFFFFF'

COLOR_RED

COLOR_RED = 'FFFF0000'

COLOR_DARKRED

COLOR_DARKRED = 'FF800000'

COLOR_BLUE

COLOR_BLUE = 'FF0000FF'

COLOR_DARKBLUE

COLOR_DARKBLUE = 'FF000080'

COLOR_GREEN

COLOR_GREEN = 'FF00FF00'

COLOR_DARKGREEN

COLOR_DARKGREEN = 'FF008000'

COLOR_YELLOW

COLOR_YELLOW = 'FFFFFF00'

COLOR_DARKYELLOW

COLOR_DARKYELLOW = 'FF808000'

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

$indexedColors

$indexedColors : array

Indexed colors array.

Type

array

$argb

$argb : string

ARGB - Alpha RGB.

Type

string

Methods

__construct()

__construct(string  $pARGB = self::COLOR_BLACK, boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new Color.

Parameters

string $pARGB

ARGB value for the colour

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\Color

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Color

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')->getFont()->getColor()->applyFromArray(['rgb' => '808080']);

Parameters

array $pStyles

Array containing style information

Returns

$this

getARGB()

getARGB() : string

Get ARGB.

Returns

string

setARGB()

setARGB(string  $pValue) : $this

Set ARGB.

Parameters

string $pValue

see self::COLOR_*

Returns

$this

getRGB()

getRGB() : string

Get RGB.

Returns

string

setRGB()

setRGB(string  $pValue) : $this

Set RGB.

Parameters

string $pValue

RGB value

Returns

$this

getRed()

getRed(string  $RGB, boolean  $hex = true) : string

Get the red colour component of an RGB value.

Parameters

string $RGB

The colour as an RGB value (e.g. FF00CCCC or CCDDEE

boolean $hex

Flag indicating whether the component should be returned as a hex or a decimal value

Returns

string —

The red colour component

getGreen()

getGreen(string  $RGB, boolean  $hex = true) : string

Get the green colour component of an RGB value.

Parameters

string $RGB

The colour as an RGB value (e.g. FF00CCCC or CCDDEE

boolean $hex

Flag indicating whether the component should be returned as a hex or a decimal value

Returns

string —

The green colour component

getBlue()

getBlue(string  $RGB, boolean  $hex = true) : string

Get the blue colour component of an RGB value.

Parameters

string $RGB

The colour as an RGB value (e.g. FF00CCCC or CCDDEE

boolean $hex

Flag indicating whether the component should be returned as a hex or a decimal value

Returns

string —

The blue colour component

changeBrightness()

changeBrightness(string  $hex, float  $adjustPercentage) : string

Adjust the brightness of a color.

Parameters

string $hex

The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)

float $adjustPercentage

The percentage by which to adjust the colour as a float from -1 to 1

Returns

string —

The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)

indexedColor()

indexedColor(integer  $pIndex, boolean  $background = false) : self

Get indexed color.

Parameters

integer $pIndex

Index entry point into the colour array

boolean $background

Flag to indicate whether default background or foreground colour should be returned if the indexed colour doesn't exist

Returns

self

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

getColourComponent()

getColourComponent(string  $RGB, integer  $offset, boolean  $hex = true) : string

Get a specified colour component of an RGB value.

Parameters

string $RGB

The colour as an RGB value (e.g. FF00CCCC or CCDDEE

integer $offset

Position within the RGB value to extract

boolean $hex

Flag indicating whether the component should be returned as a hex or a decimal value

Returns

string —

The extracted colour component