1. class
  2. Khill
  3. Lavacharts
  4. Configs
  5. SizeAxis

SizeAxis

class SizeAxis extends ConfigObject (View source)

Properties

int $maxSize Maximum radius of the largest possible bubble, in pixels.
int $maxValue The size value to be mapped to $this->maxSize.
int $minSize Mininum radius of the smallest possible bubble, in pixels.
int $minValue The size value to be mapped to $this->minSize.

Methods

mixed
__construct( array $config = array())

Builds the configuration when passed an array of options.

array
toArray( string $keyName = null)

Returns an array representation of the object.

from  ConfigObject
array
getValues()

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

from  ConfigObject
SizeAxis
maxSize( int $maxSize)

Sets maximum radius of the largest possible bubble, in pixels

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.

SizeAxis
minSize( int $minSize)

Sets mininum radius of the smallest possible bubble, in pixels

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.

Details

at line 64
mixed __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 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 75
SizeAxis maxSize( int $maxSize)

Sets maximum radius of the largest possible bubble, in pixels

Parameters

int $maxSize

Return Value

SizeAxis

at line 96
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

at line 116
SizeAxis minSize( int $minSize)

Sets mininum radius of the smallest possible bubble, in pixels

Parameters

int $minSize

Return Value

SizeAxis

at line 137
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