dojox/fx/_base.js

• Provides:

  • dojox.fx._base

• Requires:

  • dojo.fx in common

• dojox.fx.anim

  • alias - dojo.anim
  • type

    Function

  • summary

    Alias of <code>dojo.anim</code> - the shorthand <code>dojo.animateProperty</code> with auto-play

• dojox.fx.animateProperty

  • alias - dojo.animateProperty
  • type

    Function

  • summary

    Alias of <code>dojo.animateProperty</code> - animate any CSS property

• dojox.fx.fadeTo

  • alias - dojo._fade
  • type

    Function

  • summary

    Fade an element from an opacity to an opacity.
    Omit <code>start:</code> property to detect. <code>end:</code> property is required.
    Ultimately an alias to <code>dojo._fade</code>

• dojox.fx.fadeIn

  • alias - dojo.fadeIn
  • type

    Function

  • summary

    Alias of <code>dojo.fadeIn</code> - Fade a node in.

• dojox.fx.fadeOut

  • alias - dojo.fadeOut
  • type

    Function

  • summary

    Alias of <code>dojo.fadeOut</code> - Fades a node out.

• dojox.fx.combine

  • alias - dojo.fx.combine
  • type

    Function

  • summary

    Alias of <code>dojo.fx.combine</code> - Run an array of animations in parallel

• dojox.fx.chain

  • alias - dojo.fx.chain
  • type

    Function

  • summary

    Alias of <code>dojo.fx.chain</code> - Run an array of animations in sequence

• dojox.fx.slideTo

  • alias - dojo.fx.slideTo
  • type

    Function

  • summary

    Alias of <code>dojo.fx.slideTo</code> - Slide a node to a defined top/left coordinate

• dojox.fx.wipeIn

  • alias - dojo.fx.wipeIn
  • type

    Function

  • summary

    Alias of <code>dojo.fx.wipeIn</code> - Wipe a node to visible

• dojox.fx.wipeOut

  • alias - dojo.fx.wipeOut
  • type

    Function

  • summary

    Alias of <code>dojo.fx.wipeOut</code> - Wipe a node to non-visible

• dojox.fx.sizeTo

  • parameters:
    • args: (typeof Object)
  • returns

    dojo.Animation

  • summary

    Creates an animation that will size a node

  • description

    Returns an animation that will size the target node
    defined in args Object about it's center to
    a width and height defined by (args.width, args.height),
    supporting an optional method: chain||combine mixin
    (defaults to chain).
    
    - works best on absolutely or relatively positioned elements

  • example

    	// size #myNode to 400px x 200px over 1 second
    	dojo.fx.sizeTo({
    		node:'myNode',
    		duration: 1000,
    		width: 400,
    		height: 200,
    		method: "combine"
    	}).play();

  • type

    Function

• dojox.fx.slideBy

  • parameters:
    • args: (typeof Object)
  • returns

    dojo.Animation

  • summary

    Returns an animation to slide a node by a defined offset.

  • description

    Returns an animation that will slide a node (args.node) from it's
    current position to it's current posision plus the numbers defined
    in args.top and args.left. standard dojo.fx mixin's apply.

  • example

    	// slide domNode 50px down, and 22px left
    	dojox.fx.slideBy({
    		node: domNode, duration:400,
    		top: 50, left: -22
    	}).play();

  • type

    Function

• dojox.fx.crossFade

  • parameters:
    • args: (typeof Object)

      args.nodes: Array - two element array of domNodes, or id's
      
      all other standard animation args mixins apply. args.node ignored.

  • returns

    dojo.Animation

  • summary

    Returns an animation cross fading two element simultaneously

  • type

    Function

• dojox.fx.highlight

  • parameters:
    • args: (typeof Object)
  • returns

    dojo.Animation

  • summary

    Highlight a node

  • description

    Returns an animation that sets the node background to args.color
    then gradually fades back the original node background color

  • example

    	dojox.fx.highlight({ node:"foo" }).play();

  • type

    Function

• dojox.fx.wipeTo

  • parameters:
    • args: (typeof Object)
  • returns

    dojo.Animation

  • summary

    Animate a node wiping to a specific width or height

  • description

    Returns an animation that will expand the
    node defined in 'args' object from it's current to
    the height or width value given by the args object.
    
    default to height:, so leave height null and specify width:
    to wipeTo a width. note: this may be deprecated by a
    
    Note that the final value should not include
    units and should be an integer.  Thus a valid args object
    would look something like this:
    
    	dojox.fx.wipeTo({ node: "nodeId", height: 200 }).play();
    
    Node must have no margin/border/padding, so put another
    node inside your target node for additional styling.

  • type

    Function

• dojox.fx._base

  • type

    Object

• dojox.fx

  • type

    Object

• dojox

  • type

    Object