dojox/fx/Timeline.js

• Provides:

  • dojox.fx.Timeline

• Requires:

  • dojo.fx.easing in common

• dojox.fx.animateTimeline

  • parameters:
    • options: (typeof Object)

      The paramters passed to the timeline animation. Includes:
      keys: Array
      An array of objects, with style properties and values.
      duration:
      Duration of the animation in milliseconds.
      Defaults to 1000.

    • node: (typeof DomNode|String)

      DomNode The DomNode or id to be animated.

  • returns

    dojo.Animation

  • summary

    An add-on to dojo.fx that provides the ability to create
    a complex property animation based on an array of "keyframes".

  • description

    The Timeline is a replacement for the default dojo._Line.
    Instead of _Line.getValue returning a float between 0-1,
    _Timeline.getValue returns an object with all properties and
    their current values.
    A property does not have to appear in every keyframe.
    As in the example below, "height" is transitioned from the first
    keyframe to the third. "width" is transitioned from the first
    to the second to the third.
    Each keyframe can accept the following custom properties:
    step: String
    The start, finish or percentage that this keyframe represents.
    Allowed parameters are:
    0%-100%
    from (same as 0%, used to conform with the Webkit animation spec)
    to (same as 100%, used to conform with the Webkit animation spec)
    ease: String
    The string name of a dojo.fx.easing ease. Defaults to "linear". Use
    the suffix name of the ease, like: "quadIn", not: "dojo.fx.quadIn".

  • example

    	var keys = [
    	{
    		step:"0px",
    		ease:"quadInOut",
    		width:"50px",
    		height:"50px",
    	},{
    		step:"25%",
    		width:"190px"
    	},{
    		step:"100%",
    		width:"10px",
    		height:"200px",
    	}
    	];
    	ani = dojox.fx.animateTimeline({keys:keys, duration:2000}, "myDiv").play();

  • type

    Function

• dojox.fx._Timeline

  • parameters:
    • keys: (typeof Array)
  • summary

    The dojox.fx._Timeline object from which an instance
    is created

  • tags:
  • type

    Function

• dojox.fx._Timeline.keys

• dojox.fx._Timeline.flatten

  • parameters:
    • keys
  • returns

    Object

  • summary

    An internally used function that converts the keyframes
    as used in the example above into a series of key values
    which is what is used in the animation parsing.

  • type

    Function

• dojox.fx._Timeline.flatten._properties

• dojox.fx._Timeline.getValue

  • parameters:
    • p: (typeof float)
  • returns

    Object

  • summary

    Replaces the native getValue in dojo.fx.Animation.
    Returns an object with all propeties used in the animation
    and the property's current value

  • type

    Function

• dojox.fx.Timeline

  • type

    Object

• dojox.fx

  • type

    Object

• dojox

  • type

    Object