class Animation extends JsonConfig (View source)

Animation ConfigObject

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

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the Animation 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
duration( integer $duration)

The duration of the animation, in milliseconds.

easing( string $easing)

The easing function applied to the animation.

startup( bool $startup)

Determines if the chart will animate on the initial draw.

Details

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

Builds the Animation 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 68
Animation duration( integer $duration)

The duration of the animation, in milliseconds.

For details, see the animation documentation.

Parameters

integer $duration

Return Value

Animation

Exceptions

InvalidConfigValue

See also

https://developers.google.com/chart/interactive/docs/animation

at line 86
Animation easing( string $easing)

The easing function applied to the animation.

The following options are available: 'linear' - Constant speed. 'in' - Ease in - Start slow and speed up. 'out' - Ease out - Start fast and slow down. 'inAndOut' - Ease in and out - Start slow, speed up, then slow down.

Parameters

string $easing

Return Value

Animation

Exceptions

InvalidConfigValue

at line 107
Animation startup( bool $startup)

Determines if the chart will animate on the initial draw.

If true, the chart will start at the baseline and animate to its final state.

Parameters

bool $startup

Return Value

Animation

Exceptions

InvalidConfigValue