BarFormat
class BarFormat extends Format (View source)
BarFormat Object
Adds a colored bar to a numeric cell indicating whether the cell value is above or below a specified base value.
Constants
| TYPE |
Type of format object
|
Methods
Builds the BarFormat object with specified options
Shortcut method to set the value of an option and return $this.
Parses the config array by passing the values through each method to check validity against if the option exists.
A number indicating the base value, used to compare against the cell value.
A string indicating the negative value section of bars.
A string indicating the color of the positive value section of bars.
A boolean indicating if to draw a 1 pixel dark base line when negative values are present.
Details
at line 56
__construct(
array $config = array())
Builds the BarFormat object with specified options
in
JsonConfig at line 64
mixed
__get(
string $option)
Get the value of a set option via magic method.
in
JsonConfig at line 75
Options
getOptions()
Gets the Options object for the JsonConfig
in
JsonConfig at line 90
JsonConfig
setOption(
string $option,
mixed $value)
Shortcut method to set the value of an option and return $this.
In order to maintain backwards compatibility, ConfigObjects will be unwrapped.
in
JsonConfig at line 106
setOptions(
array $config)
Parses the config array by passing the values through each method to check validity against if the option exists.
in
JsonConfig at line 275
array
jsonSerialize()
Custom serialization of the JsonConfig object.
in
Format at line 46
string
getType()
Returns the format type.
at line 74
BarFormat
base(
int|float $base)
A number indicating the base value, used to compare against the cell value.
If the cell value is higher, the cell will include a green up arrow. If the cell value is lower, it will include a red down arrow. If the same, no arrow.
at line 89
BarFormat
colorNegative(
string $colorNegative)
A string indicating the negative value section of bars.
Possible values are 'red', 'green' and 'blue';
at line 110
BarFormat
colorPositive(
string $colorPositive)
A string indicating the color of the positive value section of bars.
Possible values are 'red', 'green' and 'blue'. Default is 'blue'.
at line 131
BarFormat
drawZeroLine(
boolean $drawZeroLine)
A boolean indicating if to draw a 1 pixel dark base line when negative values are present.
The dark line is there to enhance visual scanning of the bars.
at line 146
BarFormat
max(
int|float $max)
The maximum number value for the bar range.
Default value is the highest value in the table.
at line 161
BarFormat
min(
int|float $min)
The minimum number value for the bar range.
Default value is the lowest value in the table.
at line 174
BarFormat
showValue($showValue)
If true, shows values and bars; if false, shows only bars.
at line 187
BarFormat
width(
boolean $width)
Thickness of each bar, in pixels.