HistogramSeries Class Reference

Inheritance diagram for HistogramSeries:

Public Member Functions
	__construct ($type, $title, $values)
	set ($attr, $val)
	getOptions ()
	toScript ()
	showTooltips ($tooltips=null)

Public Attributes
	$type
	$title
	$values
	$options = array()
	$onClick
	$tooltips = array()

Detailed Description

Definition at line 8 of file histogram.inc.

Constructor & Destructor Documentation

__construct()

HistogramSeries::__construct	(		$type,
			$title,
			$values
	)

Definition at line 17 of file histogram.inc.

     {
          $this->type = $type;
          $this->title = $title;
          $this->values = $values;
     }

Member Function Documentation

getOptions()

HistogramSeries::getOptions

(

)

Definition at line 30 of file histogram.inc.

     {
          $options = array();
          foreach ($this->options as $opt => $val)
          {
               if ($val === false) $val = "false";
               if ($val === true) $val = "true";
               
               $options[] = "'$opt': $val";
          }
 
          if ($this->onClick)
          {
               $options[] = "'onClick': {$this->onClick} ";
          } 
 
          if (count($this->tooltips))
          {
               $tooltips = "['".implode("', '", array_map(jsSafe, $this->tooltips))."']";
               $options[] = "'toolTips': $tooltips";
          }
          
          $options = "{".implode(", ", $options)."}";
          
          return $options;
     }

set()

HistogramSeries::set	(		$attr,
			$val
	)

Definition at line 24 of file histogram.inc.

     {
          $this->options[$attr] = $val;
          return $this;
     }

showTooltips()

HistogramSeries::showTooltips

(

$tooltips = null

)

Definition at line 74 of file histogram.inc.

     {
          if ($tooltips)
          {
               $this->tooltips = $tooltips;
          }
          else
          {
               $this->tooltips = $this->values;
          }
     }

toScript()

HistogramSeries::toScript

(

)

Reimplemented in StackedHistogramSeries, and GroupedHistogramSeries.

Definition at line 57 of file histogram.inc.

     {
          $v = array();
          
          foreach($this->values as $value)
          {
               if ($value === "" || !isset($value)) $value = "null";
               $v[] = $value;
          }
           
          $values = implode(", ", $v);
          $options = $this->getOptions();
               
          $out = "new HistogramSeries('{$this->type}', '" . jsSafe($this->title) . "', [{$values}], $options)";
          return $out;
     }

Member Data Documentation

$onClick

HistogramSeries::$onClick

Definition at line 14 of file histogram.inc.

$options

HistogramSeries::$options = array()

Definition at line 13 of file histogram.inc.

$title

HistogramSeries::$title

Definition at line 11 of file histogram.inc.

$tooltips

HistogramSeries::$tooltips = array()

Definition at line 15 of file histogram.inc.

$type

HistogramSeries::$type

Definition at line 10 of file histogram.inc.

$values

HistogramSeries::$values

Definition at line 12 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