1. class
  2. Khill
  3. Lavacharts
  4. Configs
  5. BackgroundColor

BackgroundColor

class BackgroundColor extends ConfigObject (View source)

Properties

string $stroke The color of the chart border, as an HTML color string.
int $strokeWidth The border width, in pixels.
string $fill The chart fill color, as an HTML color string.

Methods

mixed
__construct( array $config = array())

Builds the backgroundColor object with specified options

array
toArray( string $keyName = null)

Returns an array representation of the object.

from  ConfigObject
array
getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

from  ConfigObject
BackgroundColor
stroke( string $stroke)

Sets the chart border color. Example: 'red' or '#A2A2A2'

BackgroundColor
strokeWidth( int $strokeWidth)

Sets the chart border width.

BackgroundColor
fill( string $fill)

Sets the chart color fill, Example: 'blue' or '#C5C5C5'

Details

at line 56
mixed __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 Array of options.

Return Value

mixed

Exceptions

InvalidConfigValue
InvalidConfigProperty

in ConfigObject at line 93
array toArray( string $keyName = null)

Returns an array representation of the object.

If passed a label, then the array will be returned with the label as the key.

Called with no label returns an array with the classname as the key.

Parameters

string $keyName Key name to be applied to generated array.

Return Value

array Assoc. array of the options of the object.

in ConfigObject at line 115
array getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

Return Value

array Array of the options of the object.

at line 67
BackgroundColor stroke( string $stroke)

Sets the chart border color. Example: 'red' or '#A2A2A2'

Parameters

string $stroke Valid HTML color string.

Return Value

BackgroundColor

at line 87
BackgroundColor strokeWidth( int $strokeWidth)

Sets the chart border width.

Parameters

int $strokeWidth Border width, in pixels.

Return Value

BackgroundColor

at line 107
BackgroundColor fill( string $fill)

Sets the chart color fill, Example: 'blue' or '#C5C5C5'

Parameters

string $fill Valid HTML color string.

Return Value

BackgroundColor