dojox/charting/plot2d/Grid.js

• Provides:

  • dojox.charting.plot2d.Grid

• Requires:

  • dojox.charting.Element in common
  • dojox.charting.plot2d.common in common
  • dojox.lang.functional in common
  • dojox.lang.utils in common

• dojox.charting.plot2d.__GridCtorArgs

  • type

    Function

  • chains:
    • dojox.charting.plot2d.__DefaultCtorArgs: (prototype)
    • dojox.charting.plot2d.__DefaultCtorArgs: (call)
  • summary

    A special keyword arguments object that is specific to a grid "plot".

• dojox.charting.plot2d.__GridCtorArgs.hMajorLines

  • optional
  • type

    Boolean

  • summary

    Whether to show lines at the major ticks along the horizontal axis. Default is true.

• dojox.charting.plot2d.__GridCtorArgs.hMinorLines

  • optional
  • type

    Boolean

  • summary

    Whether to show lines at the minor ticks along the horizontal axis. Default is false.

• dojox.charting.plot2d.__GridCtorArgs.vMajorLines

  • optional
  • type

    Boolean

  • summary

    Whether to show lines at the major ticks along the vertical axis. Default is true.

• dojox.charting.plot2d.__GridCtorArgs.vMinorLines

  • optional
  • type

    Boolean

  • summary

    Whether to show lines at the major ticks along the vertical axis. Default is false.

• dojox.charting.plot2d.__GridCtorArgs.hStripes

  • optional
  • type

    String

  • summary

    Whether or not to show stripes (alternating fills) along the horizontal axis. Default is "none".

• dojox.charting.plot2d.__GridCtorArgs.vStripes

  • optional
  • type

    String

  • summary

    Whether or not to show stripes (alternating fills) along the vertical axis. Default is "none".

• dojox.charting.plot2d.Grid

  • type

    Function

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

      The chart this plot belongs to.

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

      An optional keyword arguments object to help define the parameters of the underlying grid.

  • summary

    A "faux" plot that can be placed behind other plots to represent
    a grid against which other plots can be easily measured.
    
    
    no optional parameters

• dojox.charting.plot2d.Grid.defaultParams

  • type

    Object

• dojox.charting.plot2d.Grid.defaultParams.hAxis

  • type

    String

• dojox.charting.plot2d.Grid.defaultParams.vAxis

  • type

    String

• dojox.charting.plot2d.Grid.defaultParams.hMajorLines

  • type

    Object

• dojox.charting.plot2d.Grid.defaultParams.hMinorLines

  • type

    bool

• dojox.charting.plot2d.Grid.defaultParams.vMajorLines

  • type

    Object

• dojox.charting.plot2d.Grid.defaultParams.vMinorLines

  • type

    bool

• dojox.charting.plot2d.Grid.defaultParams.hStripes

  • type

    String

• dojox.charting.plot2d.Grid.defaultParams.vStripes

  • type

    String

• dojox.charting.plot2d.Grid.defaultParams.animate

  • type

    Object

• dojox.charting.plot2d.Grid.optionalParams

  • type

    Object

• dojox.charting.plot2d.Grid.constructor

  • constructor - constructor
  • type

    Function

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

      The chart this plot belongs to.

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

      An optional keyword arguments object to help define the parameters of the underlying grid.

  • summary

    Create the faux Grid plot.

• dojox.charting.plot2d.Grid.clear

  • returns

    dojox.charting.plot2d.Grid

  • summary

    Clear out any parameters set on this plot.

  • return_summary

    dojox.charting.plot2d.Grid
    The reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Grid._hAxis

  • type

    Object

• dojox.charting.plot2d.Grid._vAxis

  • type

    Object

• dojox.charting.plot2d.Grid.dirty

  • type

    Object

• dojox.charting.plot2d.Grid.setAxis

  • parameters:
    • axis
  • returns

    dojox.charting.plot2d.Grid

  • summary

    Set an axis for this plot.

  • return_summary

    dojox.charting.plot2d.Grid
    The reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Grid.addSeries

  • parameters:
    • run
  • returns

    dojox.charting.plot2d.Grid

  • summary

    Ignored but included as a dummy method.

  • return_summary

    dojox.charting.plot2d.Grid
    The reference to this plot for functional chaining.

  • type

    Function

• dojox.charting.plot2d.Grid.getSeriesStats

  • summary

    Returns default stats (irrelevant for this type of plot).

  • return_summary

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

  • type

    Function

• dojox.charting.plot2d.Grid.initializeScalers

  • summary

    Does nothing (irrelevant for this type of plot).

  • type

    Function

• dojox.charting.plot2d.Grid.isDirty

  • returns

    Boolean

  • summary

    Return whether or not this plot needs to be redrawn.

  • return_summary

    Boolean
    If this plot needs to be rendered, this will return true.

  • type

    Function

• dojox.charting.plot2d.Grid.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.Grid

  • summary

    Create/alter any zooming windows on this plot.

  • return_summary

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

  • type

    Function

• dojox.charting.plot2d.Grid._vAxis.scale

  • type

    Number

• dojox.charting.plot2d.Grid._hAxis.scale

  • type

    Number

• dojox.charting.plot2d.Grid.group

• dojox.charting.plot2d.Grid.getRequiredColors

  • returns

    Number

  • summary

    Ignored but included as a dummy method.

  • return_summary

    Number
    Returns 0, since there are no series associated with this plot type.

  • type

    Function

• dojox.charting.plot2d.Grid.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.Grid

  • summary

    Render the plot on the chart.

  • return_summary

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

  • type

    Function

• dojox.charting.plot2d.Grid.chart.theme.axis

• dojox.charting.plot2d.Grid._animateGrid

  • parameters:
    • shape
    • type
    • offset
    • size
  • type

    Function

• dojox.charting.plot2d.Grid.opt

  • type

    Object

• dojox.charting.plot2d.Grid.hAxis

• dojox.charting.plot2d.Grid.vAxis

• dojox.charting.plot2d.Grid.animate

• dojox.charting.plot2d.Grid.zoom

  • type

    Object

• dojox.charting.plot2d.Grid.zoomQueue

  • type

    Array

• dojox.charting.plot2d.Grid.lastWindow

  • type

    Object

• dojox.lang.utils

  • alias - dojox.lang.utils

• dojox.charting.plot2d.common

  • alias - dojox.charting.plot2d.common

• dojox.charting.plot2d

  • type

    Object

• dojox.charting

  • type

    Object

• dojox

  • type

    Object