class BoxStyle extends JsonConfig (View source)

BoxStyle Object

For charts that support annotations, the boxStyle object controls the appearance of the boxes surrounding annotations

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the boxStyle 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)

If present, specifies the color for the box outline.

strokeWidth( int|float $strokeWidth)

Sets the thickness of the box outline.

rx( int|float $rx)

Sets the x-radius of the corner curvature.

ry( int|float $ry)

Sets the y-radius of the corner curvature.

gradient( array $gradientConfig)

Sets the attributes for linear gradient fill.

Details

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

Builds the boxStyle 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 68
BoxStyle stroke( string $stroke)

If present, specifies the color for the box outline.

If undefined, a random color will be used.

Parameters

string $stroke Valid HTML color.

Return Value

BoxStyle

Exceptions

InvalidConfigValue

at line 80
BoxStyle strokeWidth( int|float $strokeWidth)

Sets the thickness of the box outline.

Parameters

int|float $strokeWidth

Return Value

BoxStyle

Exceptions

InvalidConfigValue

at line 92
BoxStyle rx( int|float $rx)

Sets the x-radius of the corner curvature.

Parameters

int|float $rx

Return Value

BoxStyle

Exceptions

InvalidConfigValue

at line 104
BoxStyle ry( int|float $ry)

Sets the y-radius of the corner curvature.

Parameters

int|float $ry

Return Value

BoxStyle

Exceptions

InvalidConfigValue

at line 116
BoxStyle gradient( array $gradientConfig)

Sets the attributes for linear gradient fill.

Parameters

array $gradientConfig

Return Value

BoxStyle

Exceptions

InvalidConfigValue