NAMED_COLORS
NAMED_COLORS = array('Black', 'White', 'Red', 'Green', 'Blue', 'Yellow', 'Magenta', 'Cyan')
__construct(string $pARGB = self::COLOR_BLACK, boolean $isSupervisor = false, boolean $isConditional = false)
Create a new 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(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style $parent, null|string $parentPropertyName = null) : $this
Bind parent. Only used for supervisor.
\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style | $parent | |
null|string | $parentPropertyName |
getSharedComponent() : \PhpOffice\PhpSpreadsheet\Style\Color
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor.
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) : self
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