dojo/NodeList-fx.js

• Provides:

  • dojo.NodeList-fx

• Requires:

  • dojo.fx in common

• dojo.NodeList

  • type

    Function

• dojo.NodeList._anim

  • parameters:
    • obj
    • method
    • args
  • returns

    dojo.Animation|dojo.NodeList

  • type

    Function

• dojo.NodeList.wipeIn

  • parameters:
    • args: (typeof Object)

      Additional dojo.Animation arguments to mix into this set with the addition of
      an <code>auto</code> parameter.

  • returns

    dojo.Animation|dojo.NodeList

  • summary

    wipe in all elements of this NodeList via <code>dojo.fx.wipeIn</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    Fade in all tables with class "blah":
    	dojo.query("table.blah").wipeIn().play();

  • example

    Utilizing `auto` to get the NodeList back:
    	dojo.query(".titles").wipeIn({ auto:true }).onclick(someFunction);

  • type

    Function

• dojo.NodeList.wipeOut

  • parameters:
    • args: (typeof Object)

      Additional dojo.Animation arguments to mix into this set with the addition of
      an <code>auto</code> parameter.

  • returns

    dojo.Animation|dojo.NodeList

  • summary

    wipe out all elements of this NodeList via <code>dojo.fx.wipeOut</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    Wipe out all tables with class "blah":
    	dojo.query("table.blah").wipeOut().play();

  • type

    Function

• dojo.NodeList.slideTo

  • parameters:
    • args: (typeof Object)

      Additional dojo.Animation arguments to mix into this set with the addition of
      an <code>auto</code> parameter.

  • returns

    dojo.Animation|dojo.NodeList

  • summary

    slide all elements of the node list to the specified place via <code>dojo.fx.slideTo</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    	Move all tables with class "blah" to 300/300:
    	dojo.query("table.blah").slideTo({
    		left: 40,
    		top: 50
    	}).play();

  • type

    Function

• dojo.NodeList.fadeIn

  • parameters:
    • args: (typeof Object)

      Additional dojo.Animation arguments to mix into this set with the addition of
      an <code>auto</code> parameter.

  • returns

    dojo.Animation|dojo.NodeList

  • summary

    fade in all elements of this NodeList via <code>dojo.fadeIn</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    Fade in all tables with class "blah":
    	dojo.query("table.blah").fadeIn().play();

  • type

    Function

• dojo.NodeList.fadeOut

  • parameters:
    • args: (typeof Object)

      Additional dojo.Animation arguments to mix into this set with the addition of
      an <code>auto</code> parameter.

  • returns

    dojo.Animation|dojo.NodeList

  • summary

    fade out all elements of this NodeList via <code>dojo.fadeOut</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    Fade out all elements with class "zork":
    	dojo.query(".zork").fadeOut().play();

  • example

    Fade them on a delay and do something at the end:
    	var fo = dojo.query(".zork").fadeOut();
    	dojo.connect(fo, "onEnd", function(){ /*...*/ });
    	fo.play();

  • example

    Using `auto`:
    	dojo.query("li").fadeOut({ auto:true }).filter(filterFn).forEach(doit);

  • type

    Function

• dojo.NodeList.animateProperty

  • parameters:
    • args
  • returns

    dojo.Animation|dojo.NodeList

  • summary

    Animate all elements of this NodeList across the properties specified.
    syntax identical to <code>dojo.animateProperty</code>

  • return_summary

    dojo.Animation|dojo.NodeList
    A special args member `auto` can be passed to automatically play the animation.
    If args.auto is present, the original dojo.NodeList will be returned for further
    chaining. Otherwise the dojo.Animation instance is returned and must be .play()'ed

  • example

    	dojo.query(".zork").animateProperty({
    		duration: 500,
    		properties: {
    			color:		{ start: "black", end: "white" },
    			left:		{ end: 300 }
    		}
    	}).play();

  • example

    	dojo.query(".grue").animateProperty({
    		auto:true,
    		properties: {
    			height:240
    		}
    	}).onclick(handler);

  • type

    Function

• dojo.NodeList.anim

  • parameters:
    • properties: (typeof Object)

      the properties to animate. does NOT support the <code>auto</code> parameter like other
      NodeList-fx methods.

    • duration: (typeof Integer)

      Optional. The time to run the animations for

    • easing: (typeof Function)

      Optional. The easing function to use.

    • onEnd: (typeof Function)

      A function to be called when the animation ends

    • delay: (typeof Integer)

      how long to delay playing the returned animation

  • returns

    dojo.Animation

  • summary

    Animate one or more CSS properties for all nodes in this list.
    The returned animation object will already be playing when it
    is returned. See the docs for <code>dojo.anim</code> for full details.

  • example

    Another way to fade out:
    	dojo.query(".thinger").anim({ opacity: 0 });

  • example

    animate all elements with the "thigner" class to a width of 500
    pixels over half a second
    	dojo.query(".thinger").anim({ width: 500 }, 700);

  • type

    Function

• dojo.NodeList-fx

  • summary

    Adds dojo.fx animation support to dojo.query()

  • type

    Object

• dojo

  • type

    Object