dojox/charting/action2d/Base.js

  • Provides:

    • dojox.charting.action2d.Base

  • Requires:

    • dojo.fx.easing in common in project dojo
    • dojox.lang.functional.object in common
    • dojox.gfx.fx in common

  • dojox.charting.action2d.Base

    • type
      Function
    • parameters:
      • chart: (typeof dojox.charting.Chart2D)
        The chart this action applies to.
      • plot: (typeof String)
        The name of the plot this action belongs to.  If none is passed "default" is assumed.
      • kwargs: (typeof dojox.charting.action2d.__BaseCtorArgs)
        Optional arguments for the action.
    • source: [view]
         this.chart = chart;
         this.plot = plot || "default";
         this.anim = {};


         // process common optional named parameters
         if(!kwargs){ kwargs = {}; }
         this.duration = kwargs.duration ? kwargs.duration : DEFAULT_DURATION;
         this.easing = kwargs.easing ? kwargs.easing : DEFAULT_EASING;
    • summary
      Create a new base Action.

  • dojox.charting.action2d.Base.overOutEvents

    • type
      Object
    • summary
  • dojox.charting.action2d.Base.connect
       
    • type
      Function
    • source: [view] 
                    
      

                       this.handle = this.chart.connectToPlot(this.plot, this, "process");
                    
      
                    
    • summary
      Connect this action to the given plot.
  • dojox.charting.action2d.Base.disconnect
       
    • type
      Function
    • source: [view] 
                    
      

                       if(this.handle){
          dojo.disconnect(this.handle);
          this.handle = null;
         }
                    
      
                    
    • summary
      Disconnect this action from the given plot, if connected.
  • dojox.charting.action2d.Base.reset
       
    • type
      Function
    • source: [view] 
                    
      

                       // summary:
         //  Reset the action.
                    
      
                    
    • summary
      Reset the action.
  • dojox.charting.action2d.Base.destroy
       
    • type
      Function
    • source: [view] 
                    
      

                       this.disconnect();
         df.forIn(this.anim, function(o){
          df.forIn(o, function(anim){
           anim.action.stop(true);
          });
         });
         this.anim = {};
                    
      
                    
    • summary
      Do any cleanup needed when destroying parent elements.
  • dojox.charting.action2d.Base.overOutEvents.onmouseover
       
    • summary
  • dojox.charting.action2d.Base.overOutEvents.onmouseout
       
    • summary
  • dojox.charting.action2d.Base.handle
       
    • summary
  • dojox.charting.action2d.Base.anim
       
    • summary
  • dojox.charting.action2d.Base.chart
       
    • type
      dojox.charting.Chart2D
    • summary
      The chart this action applies to.
  • dojox.charting.action2d.Base.plot
       
    • type
      String?
    • summary
      The name of the plot this action belongs to.  If none is passed "default" is assumed.
  • dojox.charting.action2d.Base.duration
       
    • summary
  • dojox.charting.action2d.Base.easing
       
    • summary
  • dojox.charting.action2d.__BaseCtorArgs
       
    • type
      Function
    • parameters: 
      • duration: (typeof Number)
        The amount of time in milliseconds for an animation to last.  Default is 400.
      • easing: (typeof dojo.fx.easing.*)
        An easing object (see dojo.fx.easing) for use in an animation.  The
default is dojo.fx.easing.backOut.
    • source: [view] 
                    
      

                     this.duration = duration;
       this.easing = easing;
                    
      
                    
    • summary
      The base keyword arguments object for creating an action2d.
  • dojox.charting.action2d.__BaseCtorArgs.duration
       
    • type
      Number?
    • summary
      The amount of time in milliseconds for an animation to last.  Default is 400.
  • dojox.charting.action2d.__BaseCtorArgs.easing
       
    • type
      dojo.fx.easing.*?
    • summary
      An easing object (see dojo.fx.easing) for use in an animation.  The
default is dojo.fx.easing.backOut.
  • DEFAULT_EASING
       
    • summary
  • df
       
    • summary
  • kwargs
       
    • type
      Object
    • summary
  • dojox.charting.action2d
       
    • type
      Object
    • summary
  • dojox.charting
       
    • type
      Object
    • summary
  • dojox
       
    • type
      Object
    • summary