Top
You are looking at an outdated 7.13.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.core.utils.Animation Improve this Doc

Methods Overview

Specific settings
duration()Animation duration.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Interactivity
enabled()Animation state (enabled or disabled)

Methods Description

duration

Getter for current animation duration.

Returns:

number - The current animation duration in ms.

Try it:

Setter for animation duration in milliseconds. See sample at anychart.core.Chart#animation.

Params:

Name Type Default Description
value number
1000
Value to set.

Returns:

anychart.core.utils.Animation - Self instance for method chaining.

enabled

Getter for the current animation state.

Returns:

boolean - The current animation state.

Try it:

Setter for the animation enabled state.
See sample at anychart.core.Chart#animation.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.utils.Animation - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it: