Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

PulseAnimation

MikhailTymchukDX edited this page Apr 12, 2017 · 2 revisions

PulseAnimation (inherits SequenceAnimation)

The PulseAnimation fades an element in and our repeatedly to create a pulsating effect. The iterations determines how many pulses there will be (which defaults to three, but it will repeat infinitely if given zero or less). The duration property defines the duration of each fade in or fade out, not the duration of the animation as a whole.

Client properties

Name Description
forceLayoutInIE Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its background color (the latter is required in case the user has ClearType enabled). The default value is true. This is obviously ignored when working in other browsers.
maximumOpacity Maximum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 1.
minimumOpacity Minimum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 0.

Client methods

Name Description
constructor(target, duration, fps, iterations, minimumOpacity, maximumOpacity, forceLayoutInIE)
setDuration(value) Override the duration property.
setFps(value) Override the fps property.

Client properties

forceLayoutInIE

Whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its background color (the latter is required in case the user has ClearType enabled). The default value is true. This is obviously ignored when working in other browsers.

Getter name: get_forceLayoutInIE()
Setter name: set_forceLayoutInIE(value)

maximumOpacity

Maximum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 1.

Getter name: get_maximumOpacity()
Setter name: set_maximumOpacity(value)

minimumOpacity

Minimum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 0.

Getter name: get_minimumOpacity()
Setter name: set_minimumOpacity(value)

Client methods

constructor(target, duration, fps, iterations, minimumOpacity, maximumOpacity, forceLayoutInIE)

Params:

  • target

    • Type: Object
    • Description: Target of the animation.
  • duration

    • Type: Number
    • Description: Length of the animation in seconds. The default is 1.
  • fps

    • Type: Number
    • Description: Number of steps per second. The default is 25.
  • iterations

    • Type: Number
    • Description: Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence will repeat forever. The default value is 1 iteration.
  • minimumOpacity

    • Type: Number
    • Description: Minimum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 0.
  • maximumOpacity

    • Type: Number
    • Description: Maximum opacity to use when fading in or out. Its value can range from between 0 to 1. The default value is 1.
  • forceLayoutInIE

    • Type: Boolean
    • Description: whether or not we should force a layout to be created for Internet Explorer by giving it a width and setting its background color (the latter is required in case the user has ClearType enabled). The default value is true. This is obviously ignored when working in other browsers.

setDuration(value)

Override the duration property.

Params:

  • value
    • Type: Number
    • Description: Length of the animation in seconds.

setFps(value)

Override the fps property.

Params:

  • value
    • Type: Number
    • Description: Number of steps per second..
Clone this wiki locally