Public Member Functions
	__construct ($id, $width=300, $height=300, $chartLeft=25, $chartTop=25, $chartWidth=250, $chartHeight=250, $palette="standard")

	setSize ($width, $height)

	setContainerSize ($width, $height="0")

	positionChart ($left, $top, $width, $height)

	setLabels ($labels)

	setLabelTooltips ($labelTooltips)

	setLabelDecorations ($labelDecorations)

	setLabelSize ($size)

	setYAxisLabels ($labels)

	setStrokeWidth ($s)

	setPalette ($palette)

	showLegend ($show, $x=0, $y=0)

	addSeries ($series)

	autoScale ()

	draw ()

Public Attributes
	$cssClass

	$width

	$height

	$orientation = "vertical"

	$cssStyles

	$containerWidth

	$containerHeight

	$chartLeft

	$chartTop

	$chartWidth

	$chartHeight

	$chartBackground = "#ddd"

	$palette

	$labelSize = 12

	$labelAngle = 0

	$labelAnchor = "middle"

	$labelOffset = 20

	$strokeWidth = 1

	$animate = false

	$shadow = true

	$emboss = false

	$legend = false

	$legendX = 0

	$legendY = 0

	$legendSwatchSize = 20

	$legendLineHeight = 30

	$xAxisTitle = ""

	$yAxisTitle = ""

	$series = array()

	$ticks = 10

	$max = 0

	$min = 0

	$columnMargin = 0.2

	$morphing = false

	$startIndex = 0

	$yAxisLabels = array()

	$title = ""

	$titleSize = 20

	$enableDownload = true

	$canvasBackground = "#FFFFFF"

	$units = ""

	$scaleToFit = false

	$onDrawGrid = "null"

	$onDrawGridComplete = "null"

	$onDrawChart = "null"

	$onDrawChartComplete = "null"

	$onDrawLegend = "null"

	$onDrawLegendComplete = "null"

	$gridStrokeWidth = 1

	$showGrid = true

	$emptyValueLabel = ""

	$caption = ""

	$captionX = 10

	$captionY = 300

	$captionWidth = 280

	$captionAttributes = array()

Detailed Description

Definition at line 150 of file histogram.inc.

Constructor & Destructor Documentation

◆ __construct()

Histogram::__construct	(	$id,
		$width = `300`,
		$height = `300`,
		$chartLeft = `25`,
		$chartTop = `25`,
		$chartWidth = `250`,
		$chartHeight = `250`,
		$palette = `"standard"`
	)

Definition at line 210 of file histogram.inc.

      {
           $this->id = $id;
           $this->setSize($width, $height);
           $this->setContainerSize($width, $height);
           $this->positionChart($chartLeft, $chartTop, $chartWidth, $chartHeight);
           
           $this->palette = $palette;
      }

Member Function Documentation

◆ addSeries()

Histogram::addSeries ( $series )

Definition at line 282 of file histogram.inc.

      {
           $this->series[] = $series;
      }

◆ autoScale()

Histogram::autoScale ( )

Definition at line 287 of file histogram.inc.

      {
           $max = 0;
           $min = 0;
           
           foreach($this->series as $series)
           {
                foreach($series->values as $value)
                {
                     if ($max === null || $value > $max) $max = $value;
                     if ($min === null || $value < $min) $min = $value;
                }
           }
           
           $logMax = intval(log10($max));
           $logMin = intval(log10($min));
           $log = max($logMax, $logMin);
           
           $denom = pow(10, $log);
           
           if ($max != 0)
           {
                $max = floor(($max / $denom) + 1) * $denom; 
           }
           
           if ($min != 0)
           {
                $min = floor(($min / $denom) - 1) * $denom; 
           }
           
           $this->max = $max;
           $this->min = $min;
      }

◆ draw()

Histogram::draw ( )

Definition at line 321 of file histogram.inc.

      {
           global $script;
           
           $labels = "'".implode("', '", $this->labels) . "'";
           $labelTooltips = "'".implode("', '", $this->labelTooltips) . "'";
           
           if ($this->labelDecorations)
           {
                $decorations = array();
                foreach($this->labelDecorations as $decoration)
                {
                     $decorations[] = json_encode($decoration);
                }
  
                $labelDecorations = implode(",", $decorations);
           }
                     
           //$labelTooltips = $labels;
           
           if (count($this->yAxisLabels))
           {
                $yaxis = "'".implode("', '", $this->yAxisLabels) . "'";
                $yaxis = "\t{$this->id}.yAxisLabels = [ $yaxis ];";
           }
           
           $animate = $this->animate ? "true" : "false";
           $shadow = $this->shadow ? "true": "false";   
           $emboss = $this->emboss? "true" : "false";
           $legend = $this->legend ? "true" : "false";
           $enableDownload = $this->enableDownload ? "true" : "false";
           $showGrid = $this->showGrid ? "true" : "false";
           
           $containerWidth = is_numeric($this->containerWidth) ? $this->containerWidth . "px" : $this->containerWidth;
           $containerHeight = is_numeric($this->containerHeight) ? $this->containerHeight . "px" : $this->containerHeight;
           
           $data = "";
           
           foreach($this->series as $s)
           {
                $data .= "\t{$this->id}.addSeries(".$s->toScript().");\n";
           }
           
           $jsClass = $this->morphing ? "MorphingHistogram" : "Histogram";
      
           if ($this->caption)
           {
                $caption = jsSafe($this->caption);
                $captionAttrs = json_encode($this->captionAttributes);
                $captionBlock = <<<ENDSCRIPT
 ,
           caption: '{$caption}',
           captionX: {$this->captionX},
           captionY: {$this->captionY},
           captionWidth: {$this->captionWidth},
           captionAttributes: {$captionAttrs}
 ENDSCRIPT;
           }
                
           $title = jsSafe($this->title);
                
           $script .= <<<ENDSCRIPT
 <script type="text/javascript">
 window.addEvent('domready', function ()
 {
      var {$this->id} = new $jsClass('{$this->id}', 
      {
           width: {$this->width}, 
           height: {$this->height}, 
           orientation: '{$this->orientation}',
           chartLeft: {$this->chartLeft}, 
           chartTop: {$this->chartTop}, 
           chartWidth: {$this->chartWidth},
           chartHeight: {$this->chartHeight},
           chartBackground: '{$this->chartBackground}',
           palette: '{$this->palette}',
           labelSize: {$this->labelSize},
           labelAngle: {$this->labelAngle},
           labelAnchor: '{$this->labelAnchor}',
           labelOffset: {$this->labelOffset},
           emptyValueLabel: '{$this->emptyValueLabel}',
           strokeWidth: {$this->strokeWidth},
           gridStrokeWidth: {$this->gridStrokeWidth},
           showGrid: {$showGrid},
           animate: {$animate},
           shadow: {$shadow},
           emboss: {$emboss},
           legend: {$legend},
           legendX: {$this->legendX},
           legendY: {$this->legendY},
           legendSwatchSize: {$this->legendSwatchSize},
           legendLineHeight: {$this->legendLineHeight},
           ticks: {$this->ticks},
           max: {$this->max},
           min: {$this->min},
           startIndex: {$this->startIndex},
           columnMargin: {$this->columnMargin},
           title: '{$title}',
           titleSize: {$this->titleSize},
           enableDownload: {$enableDownload},
           canvasBackground: '{$this->canvasBackground}',
           units: '{$this->units}',
           onDrawGrid: {$this->onDrawGrid},
          onDrawGridComplete: {$this->onDrawGridComplete},
           onDrawChart: {$this->onDrawChart},
          onDrawChartComplete: {$this->onDrawChartComplete},
          onDrawLegend: {$this->onDrawLegend},
           onDrawLegendComplete: {$this->onDrawLegendComplete}{$captionBlock}
      });
      
      {$this->id}.labels = [ {$labels} ];
      {$this->id}.labelTooltips = [ {$labelTooltips} ];
      {$this->id}.labelDecorations = [ {$labelDecorations} ];
      
 {$yaxis}
 {$data}
      {$this->id}.draw();
 });
 </script>
 ENDSCRIPT;
      
           if ($this->scaleToFit)
           {
                $dimensions = "width: 100%; height: auto";
           }
           else
           {
                $dimensions = "width: {$containerWidth}; height: {$containerHeight};";
           }
           
           $cssClass = ($this->cssClass) ? " class='{$this->cssClass}'" : "";
           
           echo "<div id='{$this->id}'{$cssClass} style='{$this->cssStyles}'></div>";
      }    

◆ positionChart()

Histogram::positionChart	(	$left,
		$top,
		$width,
		$height
	)

Definition at line 232 of file histogram.inc.

      {
           $this->chartLeft = $left;
           $this->chartTop = $top;
           $this->chartWidth = $width;
           $this->chartHeight = $height;
      }

◆ setContainerSize()

Histogram::setContainerSize	(	$width,
		$height = `"0"`
	)

Definition at line 226 of file histogram.inc.

      {
           $this->containerWidth = $width;
           $this->containerHeight = $height;
      }

◆ setLabelDecorations()

Histogram::setLabelDecorations ( $labelDecorations )

Definition at line 250 of file histogram.inc.

      {
           $this->labelDecorations = $labelDecorations;
      }

◆ setLabels()

Histogram::setLabels ( $labels )

Definition at line 240 of file histogram.inc.

      {
           $this->labels = $labels;
      }

◆ setLabelSize()

Histogram::setLabelSize ( $size )

Definition at line 255 of file histogram.inc.

      {
           $this->labelSize = $size;
      }

◆ setLabelTooltips()

Histogram::setLabelTooltips ( $labelTooltips )

Definition at line 245 of file histogram.inc.

      {
          $this->labelTooltips = $labelTooltips;
      }

◆ setPalette()

Histogram::setPalette ( $palette )

Definition at line 270 of file histogram.inc.

      {
           $this->palette = $palette;
      }

◆ setSize()

Histogram::setSize	(	$width,
		$height
	)

Definition at line 220 of file histogram.inc.

      {
           $this->width = $width;
           $this->height = $height;
      }

◆ setStrokeWidth()

Histogram::setStrokeWidth ( $s )

Definition at line 265 of file histogram.inc.

      {
           $this->strokeWidth = $s;
      }

◆ setYAxisLabels()

Histogram::setYAxisLabels ( $labels )

Definition at line 260 of file histogram.inc.

      {
           $this->yAxisLabels = $labels;
      }

◆ showLegend()

Histogram::showLegend	(	$show,
		$x = `0`,
		$y = `0`
	)

Definition at line 275 of file histogram.inc.

      {
           $this->legend = $show;
           $this->legendX = $x;
           $this->legendY = $y;
      }

Member Data Documentation

◆ $animate

Histogram::$animate = false

Definition at line 170 of file histogram.inc.

◆ $canvasBackground

Histogram::$canvasBackground = "#FFFFFF"

Definition at line 191 of file histogram.inc.

◆ $caption

Histogram::$caption = ""

Definition at line 204 of file histogram.inc.

◆ $captionAttributes

Histogram::$captionAttributes = array()

Definition at line 208 of file histogram.inc.

◆ $captionWidth

Histogram::$captionWidth = 280

Definition at line 207 of file histogram.inc.

◆ $captionX

Histogram::$captionX = 10

Definition at line 205 of file histogram.inc.

◆ $captionY

Histogram::$captionY = 300

Definition at line 206 of file histogram.inc.

◆ $chartBackground

Histogram::$chartBackground = "#ddd"

Definition at line 163 of file histogram.inc.

◆ $chartHeight

Histogram::$chartHeight

Definition at line 162 of file histogram.inc.

◆ $chartLeft

Histogram::$chartLeft

Definition at line 159 of file histogram.inc.

◆ $chartTop

Histogram::$chartTop

Definition at line 160 of file histogram.inc.

◆ $chartWidth

Histogram::$chartWidth

Definition at line 161 of file histogram.inc.

◆ $columnMargin

Histogram::$columnMargin = 0.2

Definition at line 184 of file histogram.inc.

◆ $containerHeight

Histogram::$containerHeight

Definition at line 158 of file histogram.inc.

◆ $containerWidth

Histogram::$containerWidth

Definition at line 157 of file histogram.inc.

◆ $cssClass

Histogram::$cssClass

Definition at line 152 of file histogram.inc.

◆ $cssStyles

Histogram::$cssStyles

Definition at line 156 of file histogram.inc.

◆ $emboss

Histogram::$emboss = false

Definition at line 172 of file histogram.inc.

◆ $emptyValueLabel

Histogram::$emptyValueLabel = ""

Definition at line 202 of file histogram.inc.

◆ $enableDownload

Histogram::$enableDownload = true

Definition at line 190 of file histogram.inc.

◆ $gridStrokeWidth

Histogram::$gridStrokeWidth = 1

Definition at line 200 of file histogram.inc.

◆ $height

Histogram::$height

Definition at line 154 of file histogram.inc.

◆ $labelAnchor

Histogram::$labelAnchor = "middle"

Definition at line 167 of file histogram.inc.

◆ $labelAngle

Histogram::$labelAngle = 0

Definition at line 166 of file histogram.inc.

◆ $labelOffset

Histogram::$labelOffset = 20

Definition at line 168 of file histogram.inc.

◆ $labelSize

Histogram::$labelSize = 12

Definition at line 165 of file histogram.inc.

◆ $legend

Histogram::$legend = false

Definition at line 173 of file histogram.inc.

◆ $legendLineHeight

Histogram::$legendLineHeight = 30

Definition at line 177 of file histogram.inc.

◆ $legendSwatchSize

Histogram::$legendSwatchSize = 20

Definition at line 176 of file histogram.inc.

◆ $legendX

Histogram::$legendX = 0

Definition at line 174 of file histogram.inc.

◆ $legendY

Histogram::$legendY = 0

Definition at line 175 of file histogram.inc.

◆ $max

Histogram::$max = 0

Definition at line 182 of file histogram.inc.

◆ $min

Histogram::$min = 0

Definition at line 183 of file histogram.inc.

◆ $morphing

Histogram::$morphing = false

Definition at line 185 of file histogram.inc.

◆ $onDrawChart

Histogram::$onDrawChart = "null"

Definition at line 196 of file histogram.inc.

◆ $onDrawChartComplete

Histogram::$onDrawChartComplete = "null"

Definition at line 197 of file histogram.inc.

◆ $onDrawGrid

Histogram::$onDrawGrid = "null"

Definition at line 194 of file histogram.inc.

◆ $onDrawGridComplete

Histogram::$onDrawGridComplete = "null"

Definition at line 195 of file histogram.inc.

◆ $onDrawLegend

Histogram::$onDrawLegend = "null"

Definition at line 198 of file histogram.inc.

◆ $onDrawLegendComplete

Histogram::$onDrawLegendComplete = "null"

Definition at line 199 of file histogram.inc.

◆ $orientation

Histogram::$orientation = "vertical"

Definition at line 155 of file histogram.inc.

◆ $palette

Histogram::$palette

Definition at line 164 of file histogram.inc.

◆ $scaleToFit

Histogram::$scaleToFit = false

Definition at line 193 of file histogram.inc.

◆ $series

Histogram::$series = array()

Definition at line 180 of file histogram.inc.

◆ $shadow

Histogram::$shadow = true

Definition at line 171 of file histogram.inc.

◆ $showGrid

Histogram::$showGrid = true

Definition at line 201 of file histogram.inc.

◆ $startIndex

Histogram::$startIndex = 0

Definition at line 186 of file histogram.inc.

◆ $strokeWidth

Histogram::$strokeWidth = 1

Definition at line 169 of file histogram.inc.

◆ $ticks

Histogram::$ticks = 10

Definition at line 181 of file histogram.inc.

◆ $title

Histogram::$title = ""

Definition at line 188 of file histogram.inc.

◆ $titleSize

Histogram::$titleSize = 20

Definition at line 189 of file histogram.inc.

◆ $units

Histogram::$units = ""

Definition at line 192 of file histogram.inc.

◆ $width

Histogram::$width

Definition at line 153 of file histogram.inc.

◆ $xAxisTitle

Histogram::$xAxisTitle = ""

Definition at line 178 of file histogram.inc.

◆ $yAxisLabels

Histogram::$yAxisLabels = array()

Definition at line 187 of file histogram.inc.

◆ $yAxisTitle

Histogram::$yAxisTitle = ""

Definition at line 179 of file histogram.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/cms/components/svg_charts/histogram.inc

Public Member Functions

Public Attributes