class Stroke extends JsonConfig (View source)

Stroke Object

An object that specifies a the color, thickness and opacity of borders in charts.

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the Stroke 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
stroke( string $stroke)

Sets the color of the stroke.

strokeOpacity( float $strokeOpacity)

Sets the opacity of the stroke.

strokeWidth( int $strokeWidth)

Sets the width of the stroke.

Details

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

Builds the Stroke object with specified options

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 67
Stroke stroke( string $stroke)

Sets the color of the stroke.

Parameters

string $stroke A valid html color string

Return Value

Stroke

Exceptions

InvalidConfigValue

at line 79
Stroke strokeOpacity( float $strokeOpacity)

Sets the opacity of the stroke.

Parameters

float $strokeOpacity

Return Value

Stroke

Exceptions

InvalidConfigValue

at line 99
Stroke strokeWidth( int $strokeWidth)

Sets the width of the stroke.

Parameters

int $strokeWidth

Return Value

Stroke

Exceptions

InvalidConfigValue