COLOR_BLACK
COLOR_BLACK = 'FF000000'
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
$parent : \PHPExcel_Style
Parent. Only used for supervisor
__construct(string $pARGB = \PHPExcel_Style_Color::COLOR_BLACK, boolean $isSupervisor = false, boolean $isConditional = false)
Create a new PHPExcel_Style_Color
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(mixed $parent, string $parentPropertyName = null) : \PHPExcel_Style_Color
Bind parent. Only used for supervisor
mixed | $parent | |
string | $parentPropertyName |
getActiveSheet() : \PHPExcel_Worksheet
Get the currently active sheet. Only used for supervisor
getSharedComponent() : \PHPExcel_Style_Color
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor
applyFromArray(array $pStyles = null) : \PHPExcel_Style_Color
Apply styles from array
$objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') );
array | $pStyles | Array containing style information |
setARGB(string $pValue = \PHPExcel_Style_Color::COLOR_BLACK) : \PHPExcel_Style_Color
Set ARGB
string | $pValue |
setRGB(string $pValue = '000000') : \PHPExcel_Style_Color
Set RGB
string | $pValue | RGB value |
getRed(string $RGB, boolean $hex = true) : string
Get the red colour component of an RGB value
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 |
The red colour component
getGreen(string $RGB, boolean $hex = true) : string
Get the green colour component of an RGB value
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 |
The green colour component
getBlue(string $RGB, boolean $hex = true) : string
Get the blue colour component of an RGB value
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 |
The blue colour component
changeBrightness(string $hex, float $adjustPercentage) : string
Adjust the brightness of a color
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 |
The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)
indexedColor(integer $pIndex, boolean $background = false) : \PHPExcel_Style_Color
Get indexed color
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 |
getColourComponent(string $RGB, integer $offset, boolean $hex = true) : string
Get a specified colour component of an RGB value
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 |
The extracted colour component