class SizeAxis extends JsonConfig (View source)

SizeAxis Object

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

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the configuration when passed an array of 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
maxSize( int $maxSize)

Sets maximum radius of the largest possible bubble, in pixels.

maxValue( int $maxValue)

Set the size value (as appears in the chart data) to be mapped to $this->maxSize.

minSize( int $minSize)

Sets minimum radius of the smallest possible bubble, in pixels

minValue( int $minValue)

Set the size value (as appears in the chart data) to be mapped to $this->minSize.

Details

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

Builds the configuration when passed an array of options.

All options can be set by either passing an array with associative values for option => value, or by chaining together the functions once an object has been created.

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 70
SizeAxis maxSize( int $maxSize)

Sets maximum radius of the largest possible bubble, in pixels.

Parameters

int $maxSize

Return Value

SizeAxis

Exceptions

InvalidConfigValue

at line 85
SizeAxis maxValue( int $maxValue)

Set the size value (as appears in the chart data) to be mapped to $this->maxSize.

Larger values will be cropped to this value.

Parameters

int $maxValue

Return Value

SizeAxis

Exceptions

InvalidConfigValue

at line 97
SizeAxis minSize( int $minSize)

Sets minimum radius of the smallest possible bubble, in pixels

Parameters

int $minSize

Return Value

SizeAxis

Exceptions

InvalidConfigValue

at line 112
SizeAxis minValue( int $minValue)

Set the size value (as appears in the chart data) to be mapped to $this->minSize.

Larger values will be cropped to this value.

Parameters

int $minValue

Return Value

SizeAxis

Exceptions

InvalidConfigValue