dojox/charting/plot2d/Base.js

• Provides:

  • dojox.charting.plot2d.Base

• Requires:

  • dojox.charting.scaler.primitive in common
  • dojox.charting.Element in common
  • dojox.charting.plot2d.common in common
  • dojox.charting.plot2d._PlotEvents in common

• dojox.charting.plot2d.Base

  • type

    Function

  • chains:
    • dojox.charting.Element: (prototype)
    • dojox.charting.plot2d._PlotEvents.prototype: (prototype)
    • dojox.charting.Element: (call)
    • dojox.charting.plot2d._PlotEvents: (call)
  • parameters:
    • chart: (typeof dojox.chart.Chart2D)

      The chart this plot belongs to.

    • kwArgs: (typeof dojox.charting.plot2d.__PlotCtorArgs)

      An optional arguments object to help define the plot.

  • summary

    Create a base plot for charting.

• dojox.charting.plot2d.Base.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • chart: (typeof dojox.chart.Chart2D)

      The chart this plot belongs to.

    • kwArgs: (typeof dojox.charting.plot2d.__PlotCtorArgs)

      An optional arguments object to help define the plot.

  • summary

    Create a base plot for charting.

• dojox.charting.plot2d.Base.clear

  • returns

    dojox.charting.plot2d.Base

  • summary

    Clear out all of the information tied to this plot.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base.series

  • type

    Array

• dojox.charting.plot2d.Base._hAxis

  • type

    Object

• dojox.charting.plot2d.Base._vAxis

  • type

    Object

• dojox.charting.plot2d.Base.dirty

  • type

    Object

• dojox.charting.plot2d.Base.setAxis

  • parameters:
    • axis: (typeof dojox.charting.axis2d.Base)

      The axis to set.

  • returns

    dojox.charting.plot2d.Base

  • summary

    Set an axis for this plot.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base.addSeries

  • parameters:
    • run: (typeof dojox.charting.Series)

      The series to be added.

  • returns

    dojox.charting.plot2d.Base

  • summary

    Add a data series to this plot.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base.getSeriesStats

  • summary

    Calculate the min/max on all attached series in both directions.

  • return_summary

    Object
    {hmin, hmax, vmin, vmax} min/max in both directions.

  • type

    Function

• dojox.charting.plot2d.Base.calculateAxes

  • parameters:
    • dim: (typeof Object)

      An object of the form { width, height }

  • returns

    dojox.charting.plot2d.Base

  • summary

    Stub function for running the axis calculations (depricated).

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base.isDirty

  • returns

    Boolean

  • summary

    Returns whether or not this plot needs to be rendered.

  • return_summary

    Boolean
    The state of the plot.

  • type

    Function

• dojox.charting.plot2d.Base.isDataDirty

  • returns

    Boolean

  • summary

    Returns whether or not any of this plot's data series need to be rendered.

  • return_summary

    Boolean
    Flag indicating if any of this plot's series are invalid and need rendering.

  • type

    Function

• dojox.charting.plot2d.Base.performZoom

  • parameters:
    • dim: (typeof Object)

      An object of the form { width, height }.

    • offsets: (typeof Object)

      An object of the form { l, r, t, b }.

  • returns

    dojox.charting.plot2d.Base

  • summary

    Create/alter any zooming windows on this plot.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base._vAxis.scale

  • type

    Number

• dojox.charting.plot2d.Base._hAxis.scale

  • type

    Number

• dojox.charting.plot2d.Base._hScaler.bounds

• dojox.charting.plot2d.Base._vScaler.bounds

• dojox.charting.plot2d.Base.group

• dojox.charting.plot2d.Base.render

  • parameters:
    • dim: (typeof Object)

      An object of the form { width, height }.

    • offsets: (typeof Object)

      An object of the form { l, r, t, b }.

  • returns

    dojox.charting.plot2d.Base

  • summary

    Render the plot on the chart.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base.getRequiredColors

  • returns

    Number

  • summary

    Get how many data series we have, so we know how many colors to use.

  • return_summary

    Number
    The number of colors needed.

  • type

    Function

• dojox.charting.plot2d.Base.initializeScalers

  • parameters:
    • dim: (typeof Object:)

      Size of a plot area in pixels as {width, height}.

    • stats: (typeof Object:)

      Min/max of data in both directions as {hmin, hmax, vmin, vmax}.

  • returns

    dojox.charting.plot2d.Base

  • summary

    Initializes scalers using attached axes.

  • return_summary

    dojox.charting.plot2d.Base
    A reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Base._hScaler

  • type

    Object

• dojox.charting.plot2d.Base._vScaler

  • type

    Object

• dojox.charting.plot2d.Base.zoom

  • type

    Object

• dojox.charting.plot2d.Base.zoomQueue

  • type

    Array

• dojox.charting.plot2d.Base.lastWindow

  • type

    Object

• dojox.charting.plot2d.__PlotCtorArgs

  • summary

    The base keyword arguments object for plot constructors.
    Note that the parameters for this may change based on the
    specific plot type (see the corresponding plot type for
    details).

  • type

    Function

• dojox.charting.plot2d

  • type

    Object

• dojox.charting

  • type

    Object

• dojox

  • type

    Object