class MagnifyingGlass extends JsonConfig (View source)

MagnifyingGlass Object

An object containing all the values for the magnifying glass which can be passed into the chart's options. If created with no parameter, it defaults to enabled with a zoom factor of 5. Passing a number in upon creation, then the zoomFactor will be set.

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the MagnifyingGlass object.

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
enable( bool $enable)

Sets whether the magnifying glass is enabled or not.

zoomFactor( integer $zoomFactor)

The zoom factor of the magnifying glass.

Details

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

Builds the MagnifyingGlass object.

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 75
MagnifyingGlass enable( bool $enable)

Sets whether the magnifying glass is enabled or not.

Parameters

bool $enable

Return Value

MagnifyingGlass

Exceptions

InvalidConfigValue

at line 87
MagnifyingGlass zoomFactor( integer $zoomFactor)

The zoom factor of the magnifying glass.

Parameters

integer $zoomFactor Can be any number greater than 0.

Return Value

MagnifyingGlass

Exceptions

InvalidConfigValue