NAMED_COLORS
NAMED_COLORS = ['Black', 'White', 'Red', 'Green', 'Blue', 'Yellow', 'Magenta', 'Cyan']
$isSupervisor : bool
Supervisor?
$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style
Parent. Only used for supervisor.
$parentPropertyName : null|string
Parent property name.
$indexedColors : array
Indexed colors array.
$argb : string
ARGB - Alpha RGB.
__construct(string $pARGB = self::COLOR_BLACK, bool $isSupervisor = false, bool $isConditional = false) : mixed
Create a new Color.
| string | $pARGB | ARGB value for the colour |
| bool | $isSupervisor | Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are |
| bool | $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 |
getRed(string $RGB, bool $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 |
| bool | $hex | Flag indicating whether the component should be returned as a hex or a decimal value |
The red colour component
getGreen(string $RGB, bool $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 |
| bool | $hex | Flag indicating whether the component should be returned as a hex or a decimal value |
The green colour component
getBlue(string $RGB, bool $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 |
| bool | $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(int $pIndex, bool $background = false) : self
Get indexed color.
| int | $pIndex | Index entry point into the colour array |
| bool | $background | Flag to indicate whether default background or foreground colour should be returned if the indexed colour doesn't exist |
exportArray2(array $exportedArray, string $index, mixed $objOrValue) : void
Populate array from exportArray1.
This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.
| array | $exportedArray | |
| string | $index | |
| mixed | $objOrValue |
getColourComponent(string $RGB, int $offset, bool $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 |
| int | $offset | Position within the RGB value to extract |
| bool | $hex | Flag indicating whether the component should be returned as a hex or a decimal value |
The extracted colour component