source: Dev/trunk/src/client/dojox/charting/action2d/PlotAction.js @ 483

define(["dojo/_base/connect", "dojo/_base/declare", "./Base", "dojo/fx/easing", "dojox/lang/functional"],
        function(hub, declare, Base, dfe, df){
        
        /*=====
        var __PlotActionCtorArgs = {
                // summary:
                //              The base keyword arguments object for creating an action2d.
                // duration: Number?
                //              The amount of time in milliseconds for an animation to last.  Default is 400.
                // easing: dojo/fx/easing/*?
                //              An easing object (see dojo.fx.easing) for use in an animation.  The
                //              default is dojo.fx.easing.backOut.
        };
        =====*/

        var DEFAULT_DURATION = 400,     // ms
                DEFAULT_EASING   = dfe.backOut;

        return declare("dojox.charting.action2d.PlotAction", Base, {
                // summary:
                //              Base action class for plot actions.

                overOutEvents: {onmouseover: 1, onmouseout: 1},

                constructor: function(chart, plot, kwargs){
                        // summary:
                        //              Create a new base PlotAction.
                        // chart: dojox/charting/Chart
                        //              The chart this action applies to.
                        // plot: String?
                        //              The name of the plot this action belongs to.  If none is passed "default" is assumed.
                        // kwargs: __PlotActionCtorArgs?
                        //              Optional arguments for the action.
                        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;
                },

                connect: function(){
                        // summary:
                        //              Connect this action to the given plot.
                        this.handle = this.chart.connectToPlot(this.plot.name, this, "process");
                },

                disconnect: function(){
                        // summary:
                        //              Disconnect this action from the given plot, if connected.
                        if(this.handle){
                                hub.disconnect(this.handle);
                                this.handle = null;
                        }
                },

                reset: function(){
                        // summary:
                        //              Reset the action.
                },

                destroy: function(){
                        // summary:
                        //              Do any cleanup needed when destroying parent elements.
                        this.inherited(arguments);
                        df.forIn(this.anim, function(o){
                                df.forIn(o, function(anim){
                                        anim.action.stop(true);
                                });
                        });
                        this.anim = {};
                }
        });
});