ConditionalColorScale
in package
Table of Contents
Methods
- colorScaleReadyForUse() : bool
- Checks that all needed color scale data is in place.
- getColorForValue() : string
- getMaximumColor() : Color|null
- getMaximumConditionalFormatValueObject() : ConditionalFormatValueObject|null
- getMidpointColor() : Color|null
- getMidpointConditionalFormatValueObject() : ConditionalFormatValueObject|null
- getMinimumColor() : Color|null
- getMinimumConditionalFormatValueObject() : ConditionalFormatValueObject|null
- getSqRef() : string|null
- prepareColorScale() : self
- Prepares color scale for execution, see the first if for variables that must be set beforehand.
- setMaximumColor() : self
- setMaximumConditionalFormatValueObject() : self
- setMidpointColor() : self
- setMidpointConditionalFormatValueObject() : self
- setMinimumColor() : self
- setMinimumConditionalFormatValueObject() : self
- setScaleArray() : self
- setSqRef() : self
Methods
colorScaleReadyForUse()
Checks that all needed color scale data is in place.
public
colorScaleReadyForUse() : bool
Return values
boolgetColorForValue()
public
getColorForValue(float $value) : string
Parameters
- $value : float
Return values
stringgetMaximumColor()
public
getMaximumColor() : Color|null
Return values
Color|nullgetMaximumConditionalFormatValueObject()
public
getMaximumConditionalFormatValueObject() : ConditionalFormatValueObject|null
Return values
ConditionalFormatValueObject|nullgetMidpointColor()
public
getMidpointColor() : Color|null
Return values
Color|nullgetMidpointConditionalFormatValueObject()
public
getMidpointConditionalFormatValueObject() : ConditionalFormatValueObject|null
Return values
ConditionalFormatValueObject|nullgetMinimumColor()
public
getMinimumColor() : Color|null
Return values
Color|nullgetMinimumConditionalFormatValueObject()
public
getMinimumConditionalFormatValueObject() : ConditionalFormatValueObject|null
Return values
ConditionalFormatValueObject|nullgetSqRef()
public
getSqRef() : string|null
Return values
string|nullprepareColorScale()
Prepares color scale for execution, see the first if for variables that must be set beforehand.
public
prepareColorScale() : self
Return values
selfsetMaximumColor()
public
setMaximumColor(Color $maximumColor) : self
Parameters
- $maximumColor : Color
Return values
selfsetMaximumConditionalFormatValueObject()
public
setMaximumConditionalFormatValueObject(ConditionalFormatValueObject $maximumConditionalFormatValueObject) : self
Parameters
- $maximumConditionalFormatValueObject : ConditionalFormatValueObject
Return values
selfsetMidpointColor()
public
setMidpointColor(Color $midpointColor) : self
Parameters
- $midpointColor : Color
Return values
selfsetMidpointConditionalFormatValueObject()
public
setMidpointConditionalFormatValueObject(ConditionalFormatValueObject $midpointConditionalFormatValueObject) : self
Parameters
- $midpointConditionalFormatValueObject : ConditionalFormatValueObject
Return values
selfsetMinimumColor()
public
setMinimumColor(Color $minimumColor) : self
Parameters
- $minimumColor : Color
Return values
selfsetMinimumConditionalFormatValueObject()
public
setMinimumConditionalFormatValueObject(ConditionalFormatValueObject $minimumConditionalFormatValueObject) : self
Parameters
- $minimumConditionalFormatValueObject : ConditionalFormatValueObject
Return values
selfsetScaleArray()
public
setScaleArray() : self
Return values
selfsetSqRef()
public
setSqRef(string $sqref, Worksheet $worksheet) : self
Parameters
- $sqref : string
- $worksheet : Worksheet