class BackgroundColor extends JsonConfig (View source)

backgroundColor Object

An object containing all the values for the backgroundColor object which can be passed into the chart's options.

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the backgroundColor object with specified options

mixed
__get( string $option)

Get the value of a set option via magic method.

from  JsonConfig
getOptions()

Gets the Options object for the JsonConfig

from  JsonConfig
setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

from  JsonConfig
setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

from  JsonConfig
array
jsonSerialize()

Custom serialization of the JsonConfig object.

from  JsonConfig
fill( string $fill)

Sets the chart color fill.

stroke( string $stroke)

Sets the chart border color.

strokeWidth( integer $strokeWidth)

Sets the chart border width.

Details

at line 54
__construct( array $config = array())

Builds the backgroundColor object with specified options

Pass an associative array with values for the keys [ stroke | strokeWidth | fill ]

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

in JsonConfig at line 64
mixed __get( string $option)

Get the value of a set option via magic method.

Parameters

string $option Name of option.

Return Value

mixed

Exceptions

InvalidConfigProperty

in JsonConfig at line 75
Options getOptions()

Gets the Options object for the JsonConfig

Return Value

Options

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.

Parameters

string $option Option to set.
mixed $value Value of the option.

Return Value

JsonConfig

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.

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

in JsonConfig at line 275
array jsonSerialize()

Custom serialization of the JsonConfig object.

Return Value

array

at line 70
BackgroundColor fill( string $fill)

Sets the chart color fill.

Example: 'blue' or '#C5C5C5'

Parameters

string $fill Valid HTML color string.

Return Value

BackgroundColor

Exceptions

InvalidConfigValue

at line 84
BackgroundColor stroke( string $stroke)

Sets the chart border color.

Example: 'red' or '#A2A2A2'

Parameters

string $stroke Valid HTML color string.

Return Value

BackgroundColor

Exceptions

InvalidConfigValue

at line 96
BackgroundColor strokeWidth( integer $strokeWidth)

Sets the chart border width.

Parameters

integer $strokeWidth Border width, in pixels.

Return Value

BackgroundColor

Exceptions

InvalidConfigValue