\PHPExcel_Style_Color

PHPExcel_Style_Color

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getARGB()
setARGB()
getRGB()
setRGB()
getRed()
getGreen()
getBlue()
changeBrightness()
indexedColor()
getHashCode()
No public properties found
COLOR_BLACK
COLOR_WHITE
COLOR_RED
COLOR_DARKRED
COLOR_BLUE
COLOR_DARKBLUE
COLOR_GREEN
COLOR_DARKGREEN
COLOR_YELLOW
COLOR_DARKYELLOW
No protected methods found
$isSupervisor
$parent
$indexedColors
$argb
$parentPropertyName
N/A
getColourComponent()
No private properties found
N/A

Constants

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 : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$indexedColors

$indexedColors : array

Indexed colors array

Type

array

$argb

$argb : string

ARGB - Alpha RGB

Type

string

$parentPropertyName

$parentPropertyName : string

Parent property name

Type

string

Methods

__construct()

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

Create a new PHPExcel_Style_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(mixed  $parent, string  $parentPropertyName = null) : \PHPExcel_Style_Color

Bind parent. Only used for supervisor

Parameters

mixed $parent
string $parentPropertyName

Returns

\PHPExcel_Style_Color

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get the currently active sheet. Only used for supervisor

Returns

\PHPExcel_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() : \PHPExcel_Style_Color

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

Only used for style supervisor

Returns

\PHPExcel_Style_Color

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Color

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') );

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Color

getARGB()

getARGB() : string

Get ARGB

Returns

string

setARGB()

setARGB(string  $pValue = \PHPExcel_Style_Color::COLOR_BLACK) : \PHPExcel_Style_Color

Set ARGB

Parameters

string $pValue

Returns

\PHPExcel_Style_Color

getRGB()

getRGB() : string

Get RGB

Returns

string

setRGB()

setRGB(string  $pValue = '000000') : \PHPExcel_Style_Color

Set RGB

Parameters

string $pValue

RGB value

Returns

\PHPExcel_Style_Color

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) : \PHPExcel_Style_Color

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

\PHPExcel_Style_Color

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