PhaseColorScheme
Table of Contents
Constants
- FAILURE_COLOR = '#FF5752'
- PROCESS_COLOR = '#39A8EF'
- PROCESS_COLORS = array('#39A8EF', '#2FC6F6', '#55D0E0', '#47E4C2', '#FFA900')
- SUCCESS_COLOR = '#7BD500'
Methods
- __construct() : mixed
- addElement() : void
- Add element
- externalize() : array<string|int, mixed>
- Get external representation of this object
- fillDefaultColors() : array<string|int, mixed>
- getDefaultColor() : string
- Get default color for element.
- getDefaultColorBySemantics() : string
- Get default element color by semantic ID.
- getElementByName() : PhaseColorSchemeElement|null
- Get scheme element by name.
- getElementNames() : array<string|int, mixed>
- Get Element Names
- internalize() : void
- Setup this object from external representation.
- isPersistent() : bool
- load() : bool
- Try to load scheme from options
- remove() : void
- Remove scheme from options
- reset() : mixed
- Reset scheme.
- save() : void
- Save scheme to options
- setupByDefault() : void
- Setup scheme by default
Constants
FAILURE_COLOR
public
mixed
FAILURE_COLOR
= '#FF5752'
PROCESS_COLOR
public
mixed
PROCESS_COLOR
= '#39A8EF'
PROCESS_COLORS
public
mixed
PROCESS_COLORS
= array('#39A8EF', '#2FC6F6', '#55D0E0', '#47E4C2', '#FFA900')
SUCCESS_COLOR
public
mixed
SUCCESS_COLOR
= '#7BD500'
Methods
__construct()
public
__construct(string $optionName) : mixed
Parameters
- $optionName : string
-
Option name.
Tags
addElement()
Add element
public
addElement(PhaseColorSchemeElement $element) : void
Parameters
- $element : PhaseColorSchemeElement
externalize()
Get external representation of this object
public
externalize() : array<string|int, mixed>
Return values
array<string|int, mixed>fillDefaultColors()
public
static fillDefaultColors(array<string|int, mixed> $stages) : array<string|int, mixed>
Parameters
- $stages : array<string|int, mixed>
Return values
array<string|int, mixed>getDefaultColor()
Get default color for element.
public
getDefaultColor(string $name[, int $index = -1 ]) : string
Parameters
- $name : string
-
Element Name.
- $index : int = -1
-
Element Index.
Return values
stringgetDefaultColorBySemantics()
Get default element color by semantic ID.
public
static getDefaultColorBySemantics(int $semanticID[, array<string|int, mixed> $options = null ]) : string
Parameters
- $semanticID : int
-
Semantic ID.
- $options : array<string|int, mixed> = null
-
.
Return values
stringgetElementByName()
Get scheme element by name.
public
getElementByName(string $name) : PhaseColorSchemeElement|null
Parameters
- $name : string
-
Item Name.
Return values
PhaseColorSchemeElement|nullgetElementNames()
Get Element Names
public
getElementNames() : array<string|int, mixed>
Return values
array<string|int, mixed>internalize()
Setup this object from external representation.
public
internalize(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
-
External params.
isPersistent()
public
isPersistent() : bool
Return values
boolload()
Try to load scheme from options
public
load() : bool
Tags
Return values
boolremove()
Remove scheme from options
public
remove() : void
reset()
Reset scheme.
public
reset() : mixed
save()
Save scheme to options
public
save() : void
setupByDefault()
Setup scheme by default
public
setupByDefault() : void