class BoxStyle extends ConfigObject (View source)

Properties

string $stroke Color of the box outline.
int|string $strokeWidth Thickness of the box outline.
int|string $rx X radius of the corner curvature.
int|string $ry Y radius of the corner curvature.
Gradient $gradient Attributes for linear gradient fill.

Methods

mixed
__construct( array $config = array())

Builds the boxStyle object with specified options

array
toArray( string $keyName = null)

Returns an array representation of the object.

array
getValues()

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

stroke( string $stroke)

If present, specifies the color for the box outline.

strokeWidth( int|string $strokeWidth)

Sets the thickness of the box outline.

rx( int|string $rx)

Sets the x-radius of the corner curvature.

ry( int|string $ry)

Sets the y-radius of the corner curvature.

gradient( Gradient $gradient)

Sets the attributes for linear gradient fill.

Details

at line 68
mixed __construct( array $config = array())

Builds the boxStyle object with specified options

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 80
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

at line 100
BoxStyle strokeWidth( int|string $strokeWidth)

Sets the thickness of the box outline.

Parameters

int|string $strokeWidth

Return Value

BoxStyle

at line 120
BoxStyle rx( int|string $rx)

Sets the x-radius of the corner curvature.

Parameters

int|string $rx

Return Value

BoxStyle

at line 140
BoxStyle ry( int|string $ry)

Sets the y-radius of the corner curvature.

Parameters

int|string $ry

Return Value

BoxStyle

at line 160
BoxStyle gradient( Gradient $gradient)

Sets the attributes for linear gradient fill.

Parameters

Gradient $gradient

Return Value

BoxStyle