Documentation

ConditionalColorScale

in package

• Application

Table of Contents

Properties

$maximumColor  : Color|null

$maximumConditionalFormatValueObject  : ConditionalFormatValueObject|null

$maxValue  : float

$midpointColor  : Color|null

$midpointConditionalFormatValueObject  : ConditionalFormatValueObject|null

$midValue  : float

$minimumColor  : Color|null

$minimumConditionalFormatValueObject  : ConditionalFormatValueObject|null

$minValue  : float

$sqref  : string|null

$valueArray  : array<string|int, mixed>

$worksheet  : Worksheet|null

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

getLimitValue()  : float