/*
Copyright (c) 2004-2011, The Dojo Foundation All Rights Reserved.
Available via Academic Free License >= 2.1 OR the modified BSD license.
see: http://dojotoolkit.org/license for details
*/
if(!dojo._hasResource["dojox.charting.axis2d.Base"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
dojo._hasResource["dojox.charting.axis2d.Base"] = true;
dojo.provide("dojox.charting.axis2d.Base");
dojo.require("dojox.charting.Element");
dojo.declare("dojox.charting.axis2d.Base", dojox.charting.Element, {
// summary:
// The base class for any axis. This is more of an interface/API
// definition than anything else; see dojox.charting.axis2d.Default
// for more details.
constructor: function(chart, kwArgs){
// summary:
// Return a new base axis.
// chart: dojox.charting.Chart2D
// The chart this axis belongs to.
// kwArgs: dojox.charting.axis2d.__AxisCtorArgs?
// An optional arguments object to define the axis parameters.
this.vertical = kwArgs && kwArgs.vertical;
},
clear: function(){
// summary:
// Stub function for clearing the axis.
// returns: dojox.charting.axis2d.Base
// A reference to the axis for functional chaining.
return this; // dojox.charting.axis2d.Base
},
initialized: function(){
// summary:
// Return a flag as to whether or not this axis has been initialized.
// returns: Boolean
// If the axis is initialized or not.
return false; // Boolean
},
calculate: function(min, max, span){
// summary:
// Stub function to run the calcuations needed for drawing this axis.
// returns: dojox.charting.axis2d.Base
// A reference to the axis for functional chaining.
return this; // dojox.charting.axis2d.Base
},
getScaler: function(){
// summary:
// A stub function to return the scaler object created during calculate.
// returns: Object
// The scaler object (see dojox.charting.scaler.linear for more information)
return null; // Object
},
getTicks: function(){
// summary:
// A stub function to return the object that helps define how ticks are rendered.
// returns: Object
// The ticks object.
return null; // Object
},
getOffsets: function(){
// summary:
// A stub function to return any offsets needed for axis and series rendering.
// returns: Object
// An object of the form { l, r, t, b }.
return {l: 0, r: 0, t: 0, b: 0}; // Object
},
render: function(dim, offsets){
// summary:
// Stub function to render this axis.
// returns: dojox.charting.axis2d.Base
// A reference to the axis for functional chaining.
this.dirty = false;
return this; // dojox.charting.axis2d.Base
}
});
}