class Slice extends JsonConfig (View source)

Slice ConfigObject

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

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the slice 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
color( string $color)

The color to use for this slice. Specify a valid HTML color string.

offset( float $offset)

How far to separate the slice from the rest of the pie.

textStyle( array $textStyleConfig)

Overrides the global pieSliceTextStyle for this slice.

Details

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

Builds the slice 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
Slice color( string $color)

The color to use for this slice. Specify a valid HTML color string.

Parameters

string $color

Return Value

Slice

Exceptions

InvalidConfigValue

at line 80
Slice offset( float $offset)

How far to separate the slice from the rest of the pie.

from 0.0 (not at all) to 1.0 (the pie's radius).

Parameters

float $offset

Return Value

Slice

Exceptions

InvalidConfigValue

at line 100
Slice textStyle( array $textStyleConfig)

Overrides the global pieSliceTextStyle for this slice.

Parameters

array $textStyleConfig

Return Value

Slice

Exceptions

InvalidConfigValue