dojox/charting/plot2d/Candlesticks.js

• Provides:

  • dojox.charting.plot2d.Candlesticks

• Requires:

  • dojox.charting.plot2d.common in common
  • dojox.charting.plot2d.Base in common
  • dojox.lang.utils in common
  • dojox.lang.functional in common
  • dojox.lang.functional.reversed in common

• dojox.charting.plot2d.Candlesticks

  • type

    Function

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

      The chart this plot belongs to.

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

      An optional keyword arguments object to help define the plot.

  • summary

    A plot that represents typical candlesticks (financial reporting, primarily).
    Unlike most charts, the Candlestick expects data points to be represented by
    an object of the form { x?, open, close, high, low, mid? }, where both
    x and mid are optional parameters.  If x is not provided, the index of the
    data array is used.

• dojox.charting.plot2d.Candlesticks.defaultParams

  • type

    Object

• dojox.charting.plot2d.Candlesticks.defaultParams.hAxis

  • type

    String

• dojox.charting.plot2d.Candlesticks.defaultParams.vAxis

  • type

    String

• dojox.charting.plot2d.Candlesticks.defaultParams.gap

  • type

    Number

• dojox.charting.plot2d.Candlesticks.defaultParams.animate

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams.minBarSize

  • type

    Number

• dojox.charting.plot2d.Candlesticks.optionalParams.maxBarSize

  • type

    Number

• dojox.charting.plot2d.Candlesticks.optionalParams.stroke

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams.outline

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams.shadow

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams.fill

  • type

    Object

• dojox.charting.plot2d.Candlesticks.optionalParams.font

  • type

    String

• dojox.charting.plot2d.Candlesticks.optionalParams.fontColor

  • type

    String

• dojox.charting.plot2d.Candlesticks.constructor

  • constructor - constructor
  • type

    Function

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

      The chart this plot belongs to.

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

      An optional keyword arguments object to help define the plot.

  • summary

    The constructor for a candlestick chart.

• dojox.charting.plot2d.Candlesticks.collectStats

  • parameters:
    • series: (typeof dojox.charting.Series[])

      The data series array to be drawn on this plot.

  • returns

    Object

  • summary

    Collect all statistics for drawing this chart.  Since the common
    functionality only assumes x and y, Candlesticks must create it's own
    stats (since data has no y value, but open/close/high/low instead).

  • return_summary

    Object
    Returns an object in the form of { hmin, hmax, vmin, vmax }.

  • type

    Function

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

  • parameters:
    • dim: (typeof Object)

      An object in the form of { width, height }

    • offsets: (typeof Object)

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

  • returns

    dojox.charting.plot2d.Candlesticks

  • summary

    Run the calculations for any axes for this plot.

  • return_summary

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

  • type

    Function

• dojox.charting.plot2d.Candlesticks.dirty

  • type

    bool

• dojox.charting.plot2d.Candlesticks._eventSeries

  • type

    Object

• dojox.charting.plot2d.Candlesticks.chart.theme

• dojox.charting.plot2d.Candlesticks._animateCandlesticks

  • parameters:
    • shape
    • voffset
    • vsize
  • type

    Function

• dojox.charting.plot2d.Candlesticks.opt

  • type

    Object

• dojox.charting.plot2d.Candlesticks.series

  • type

    Array

• dojox.charting.plot2d.Candlesticks.hAxis

• dojox.charting.plot2d.Candlesticks.vAxis

• dojox.charting.plot2d.Candlesticks.animate

• dojox.lang.functional

  • alias - dojox.lang.functional

• 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