ComponentPropertyAnimationOptions interface

The options to control the animation of a component property using Component.animateProperty().

Signature:

export interface ComponentPropertyAnimationOptions 

Properties

PropertyModifiersTypeDescription
delay?readonlynumber(Optional) The delay in seconds after which to start the animation. The default is 0.
duration?readonlynumber(Optional) The duration of the animation in seconds.
function?readonlyCubicBezier(Optional) A CubicBezier that describes the interpolation of the property value over time, if this is not set TransitionFunction.Linear is used as the default.
isDelta?readonlyboolean(Optional) If this is true, the value passed to Component.animateProperty() will be added to the current value of the property to determine the final value at the end of the animation.
stopCurrentAnimations?readonlyboolean(Optional) If this is true, all existing animations for the same property on the same component will be stopped immediately. Otherwise this animation will be combined with existing animations.

ComponentPropertyAnimationOptions.duration property

The duration of the animation in seconds.

Signature:

readonly duration?: number;

Remarks

If this is zero or not specified, the final value of the property is applied immediately.

ComponentPropertyAnimationOptions.function property

A CubicBezier that describes the interpolation of the property value over time, if this is not set TransitionFunction.Linear is used as the default.

Signature:

readonly function?: CubicBezier;

ComponentPropertyAnimationOptions.isDelta property

If this is true, the value passed to Component.animateProperty() will be added to the current value of the property to determine the final value at the end of the animation.

Signature:

readonly isDelta?: boolean;

ComponentPropertyAnimationOptions.stopCurrentAnimations property

If this is true, all existing animations for the same property on the same component will be stopped immediately. Otherwise this animation will be combined with existing animations.

Signature:

readonly stopCurrentAnimations?: boolean;

ComponentPropertyAnimationOptions.delay property

The delay in seconds after which to start the animation. The default is 0.

Signature:

readonly delay?: number;