ArrowFormat
class ArrowFormat extends Format (View source)
ArrowFormat Object
Adds an up or down arrow to a numeric cell, depending on whether the value is above or below a specified base value. If equal to the base value, no arrow is shown.
Constants
| TYPE |
Type of format object
|
Methods
Builds the ArrowFormat 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.
Details
at line 49
__construct(
array $config = array())
Builds the ArrowFormat 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 67
ArrowFormat
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.