dojox/charting/plot2d/Bars.js

  • Provides:

    • dojox.charting.plot2d.Bars
  • Requires:

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

    • type
      Function
    • chains:
      • dojox.charting.plot2d.__DefaultCtorArgs: (prototype)
      • dojox.charting.plot2d.__DefaultCtorArgs: (call)
    • summary
      Additional keyword arguments for bar charts.
  • dojox.charting.plot2d.__BarCtorArgs.minBarSize

    • type
      Number
    • summary
      The minimum size for a bar in pixels.  Default is 1.
  • dojox.charting.plot2d.__BarCtorArgs.maxBarSize

    • type
      Number
    • summary
      The maximum size for a bar in pixels.  Default is 1.
  • dojox.charting.plot2d.Bars

    • type
      Function
    • chains:
      • dojox.charting.plot2d.Base: (prototype)
      • dojox.charting.plot2d.Base: (call)
    • summary
      The constructor for a bar chart.
    • 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.
    • source: [view]
         this.opt = dojo.clone(this.defaultParams);
         du.updateWithObject(this.opt, kwArgs);
         du.updateWithPattern(this.opt, kwArgs, this.optionalParams);
         this.series = [];
         this.hAxis = this.opt.hAxis;
         this.vAxis = this.opt.vAxis;
         this.animate = this.opt.animate;
  • dojox.charting.plot2d.Bars.defaultParams

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.optionalParams

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.getSeriesStats

    • type
      Function
    • source: [view]
         var stats = dc.collectSimpleStats(this.series), t;
         stats.hmin -= 0.5;
         stats.hmax += 0.5;
         t = stats.hmin, stats.hmin = stats.vmin, stats.vmin = t;
         t = stats.hmax, stats.hmax = stats.vmax, stats.vmax = t;
         return stats;
    • summary
      Calculate the min/max on all attached series in both directions.
    • return_summary
      Object
      {hmin, hmax, vmin, vmax} min/max in both directions.
  • dojox.charting.plot2d.Bars.render

    • type
      Function
    • parameters:
      • dim: (typeof Object)
        An object in the form of { width, height }
      • offsets: (typeof Object)
        An object of the form { l, r, t, b}.
    • source: [view]
         if(this.zoom && !this.isDataDirty()){
          return this.performZoom(dim, offsets);
         }
         this.dirty = this.isDirty();
         this.resetEvents();
         if(this.dirty){
          dojo.forEach(this.series, purgeGroup);
          this._eventSeries = {};
          this.cleanGroup();
          var s = this.group;
          df.forEachRev(this.series, function(item){ item.cleanGroup(s); });
         }
         var t = this.chart.theme, f, gap, height,
          ht = this._hScaler.scaler.getTransformerFromModel(this._hScaler),
          vt = this._vScaler.scaler.getTransformerFromModel(this._vScaler),
          baseline = Math.max(0, this._hScaler.bounds.lower),
          baselineWidth = ht(baseline),
          events = this.events();
         f = dc.calculateBarSize(this._vScaler.bounds.scale, this.opt);
         gap = f.gap;
         height = f.size;
         for(var i = this.series.length - 1; i >= 0; --i){
          var run = this.series[i];
          if(!this.dirty && !run.dirty){
           t.skip();
           this._reconnectEvents(run.name);
           continue;
          }
          run.cleanGroup();
          var theme = t.next("bar", [this.opt, run]), s = run.group,
           eventSeries = new Array(run.data.length);
          for(var j = 0; j < run.data.length; ++j){
           var value = run.data[j];
           if(value !== null){
            var v = typeof value == "number" ? value : value.y,
             hv = ht(v),
             width = hv - baselineWidth,
             w = Math.abs(width),
             finalTheme = typeof value != "number" ?
              t.addMixin(theme, "bar", value, true) :
              t.post(theme, "bar");
            if(w >= 1 && height >= 1){
             var rect = {
              x: offsets.l + (v < baseline ? hv : baselineWidth),
              y: dim.height - offsets.b - vt(j + 1.5) + gap,
              width: w, height: height
             };
             var specialFill = this._plotFill(finalTheme.series.fill, dim, offsets);
             specialFill = this._shapeFill(specialFill, rect);
             var shape = s.createRect(rect).setFill(specialFill).setStroke(finalTheme.series.stroke);
             run.dyn.fill = shape.getFill();
             run.dyn.stroke = shape.getStroke();
             if(events){
              var o = {
               element: "bar",
               index: j,
               run: run,
               shape: shape,
               x: v,
               y: j + 1.5
              };
              this._connectEvents(o);
              eventSeries[j] = o;
             }
             if(this.animate){
              this._animateBar(shape, offsets.l + baselineWidth, -w);
             }
            }
           }
          }
          this._eventSeries[run.name] = eventSeries;
          run.dirty = false;
         }
         this.dirty = false;
         return this; // dojox.charting.plot2d.Bars
    • summary
      Run the calculations for any axes for this plot.
    • return_summary
      dojox.charting.plot2d.Bars
      A reference to this plot for functional chaining.
    • returns
      dojox.charting.plot2d.Bars
  • dojox.charting.plot2d.Bars._animateBar

    • type
      Function
    • parameters:
      • shape: (typeof )
      • hoffset: (typeof )
      • hsize: (typeof )
    • source: [view]
         dojox.gfx.fx.animateTransform(dojo.delegate({
          shape: shape,
          duration: 1200,
          transform: [
           {name: "translate", start: [hoffset - (hoffset/hsize), 0], end: [0, 0]},
           {name: "scale", start: [1/hsize, 1], end: [1, 1]},
           {name: "original"}
          ]
         }, this.animate)).play();
    • summary
  • dojox.charting.plot2d.Bars.defaultParams.hAxis

    • summary
  • dojox.charting.plot2d.Bars.defaultParams.vAxis

    • summary
  • dojox.charting.plot2d.Bars.defaultParams.gap

    • summary
  • dojox.charting.plot2d.Bars.defaultParams.animate

    • summary
  • dojox.charting.plot2d.Bars.optionalParams.minBarSize

    • summary
  • dojox.charting.plot2d.Bars.optionalParams.maxBarSize

    • summary
  • dojox.charting.plot2d.Bars.optionalParams.stroke

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.optionalParams.outline

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.optionalParams.shadow

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.optionalParams.fill

    • type
      Object
    • summary
  • dojox.charting.plot2d.Bars.optionalParams.font

    • summary
  • dojox.charting.plot2d.Bars.optionalParams.fontColor

    • summary
  • dojox.charting.plot2d.Bars.dirty

    • summary
  • dojox.charting.plot2d.Bars._eventSeries

    • summary
  • dojox.charting.plot2d.Bars.opt

    • summary
  • dojox.charting.plot2d.Bars.series

    • summary
  • dojox.charting.plot2d.Bars.hAxis

    • summary
  • dojox.charting.plot2d.Bars.vAxis

    • summary
  • dojox.charting.plot2d.Bars.animate

    • summary
  • dc

    • summary
  • purgeGroup

    • summary
  • dojox.charting.plot2d

    • type
      Object
    • summary
  • dojox.charting

    • type
      Object
    • summary
  • dojox

    • type
      Object
    • summary