This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilChart:

Collaboration diagram for ilChart:

Public Member Functions
	getDataInstance (?int $a_type=null)
	Get data series instance. More...

	setSize (string $a_x, string $a_y)
	Set chart size. More...

	addData (ilChartData $a_series, ?int $a_idx=null)
	Add data series. More...

	setLegend (ilChartLegend $a_legend)

	setColors (array $a_values)

	getColors ()

	setShadow (int $a_value)

	getShadow ()

	setAutoResize (bool $a_value)
	Toggle auto-resizing on window resize/redraw. More...

	setStacked (bool $a_value)

	parseGlobalOptions (stdClass $a_options)
	Convert (global) properties to flot config. More...

	getHTML ()
	Render. More...

Static Public Member Functions
static	getInstanceByType (int $a_type, string $a_id)

static	isValidColor (string $a_value)
	Validate html color code. More...

static	renderColor (string $a_value, float $a_opacity=1)
	Render html color code. More...

Data Fields
const	TYPE_GRID = 1

const	TYPE_PIE = 2

const	TYPE_SPIDER = 3

Protected Member Functions
	__construct (string $a_id)

	isValidDataType (ilChartData $a_series)
	Validate data series. More...

	isValid ()
	Basic validation. More...

	initJS ()
	Init JS script files. More...

	addCustomJS ()
	Add type-specific JS script. More...

Protected Attributes
ilGlobalTemplateInterface	$tpl

string	$id = ""

string	$width = ""

string	$height = ""

array	$data = []

ilChartLegend	$legend = null

int	$shadow = 0

array	$colors = []

bool	$auto_resize = false

bool	$stacked = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Abstract Chart generator base class

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 23 of file class.ilChart.php.

Constructor & Destructor Documentation

◆ __construct()

ilChart::__construct ( string $a_id )

protected

Definition at line 40 of file class.ilChart.php.

References $DIC, and setShadow().

     {
         global $DIC;
 
         $this->tpl = $DIC["tpl"];
         $this->id = $a_id;
         $this->data = array();
 
         $this->setShadow(2);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomJS()

ilChart::addCustomJS ( )

protected

Add type-specific JS script.

Definition at line 219 of file class.ilChart.php.

Referenced by initJS().

                                     : void
     {
     }

Here is the caller graph for this function:

◆ addData()

ilChart::addData	(	ilChartData	$a_series,
		?int	$a_idx = `null`
	)

Add data series.

Definition at line 101 of file class.ilChart.php.

References $data, isValidDataType(), and null.

      : ?int {
         if ($this->isValidDataType($a_series)) {
             if ($a_idx === null) {
                 $a_idx = sizeof($this->data);
             }
             $this->data[$a_idx] = $a_series;
             return $a_idx;
         }
         return null;
     }

Here is the call graph for this function:

◆ getColors()

ilChart::getColors ( )

Definition at line 129 of file class.ilChart.php.

References $colors.

Referenced by getHTML().

                                : array
     {
         return $this->colors;
     }

Here is the caller graph for this function:

◆ getDataInstance()

ilChart::getDataInstance ( ?int $a_type = null )

abstract

Get data series instance.

Referenced by getInstanceByType().

Here is the caller graph for this function:

◆ getHTML()

ilChart::getHTML ( )

Render.

Definition at line 233 of file class.ilChart.php.

References $stacked, getColors(), getShadow(), initJS(), isValid(), and parseGlobalOptions().

                              : string
     {
         if (!$this->isValid()) {
             return "";
         }
 
         $this->initJS();
 
         $chart = new ilTemplate("tpl.grid.html", true, true, "components/ILIAS/Chart");
         $chart->setVariable("ID", $this->id);
 
         if ($this->width) {
             if (is_numeric($this->width)) {
                 $chart->setVariable("WIDTH", "width:" . $this->width . "px;");
             } else {
                 $chart->setVariable("WIDTH", "width:" . $this->width . ";");
             }
         }
         if ($this->height) {
             if (is_numeric($this->height)) {
                 $chart->setVariable("HEIGHT", "height:" . $this->height . "px;");
             } else {
                 $chart->setVariable("HEIGHT", "height:" . $this->height . ";");
             }
         }
 
 
         // (series) data
 
         $json_series = array();
         foreach ($this->data as $series) {
             $series->parseData($json_series);
         }
         $series_str = json_encode($json_series);
 
 
         // global options
 
         $json_options = new stdClass();
         $json_options->series = new stdClass();
         $json_options->series->shadowSize = $this->getShadow();
         $json_options->series->lines = new stdClass();
         $json_options->series->lines->show = false;
         $json_options->series->stack = $this->stacked;
 
         foreach ($this->data as $series) {
             $series->parseGlobalOptions($json_options, $this);
         }
 
         $this->parseGlobalOptions($json_options);
 
         $colors = $this->getColors();
         if ($colors) {
             $json_options->colors = array();
             foreach ($colors as $color) {
                 $json_options->colors[] = self::renderColor($color);
             }
         }
 
         // legend
         $json_options->legend = new stdClass();
         if (!$this->legend) {
             $json_options->legend->show = false;
         } else {
             $this->legend->parseOptions($json_options->legend);
         }
 
         $options = json_encode($json_options);
 
         $this->tpl->addOnLoadCode('$.plot($("#ilChart' . $this->id . '"), ' . $series_str . ', ' . $options . ');');
 
         $ret = $chart->get();
         return $ret;
     }

Here is the call graph for this function:

◆ getInstanceByType()

static ilChart::getInstanceByType	(	int	$a_type,
		string	$a_id
	)

static

Definition at line 51 of file class.ilChart.php.

References getDataInstance(), isValidDataType(), and null.

Referenced by SurveyMetricQuestionEvaluation\getChart(), SurveyMatrixQuestionEvaluation\getChart(), SurveyQuestionEvaluation\getChart(), ilSessionStatisticsGUI\getChart(), ilLPObjectStatisticsTypesTableGUI\getGraph(), ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), ilLPObjectStatisticsLPTableGUI\getGraph(), and ilWikiStatGUI\renderGraph().

      : ilChart {
         switch ($a_type) {
             case self::TYPE_GRID:
                 return new ilChartGrid($a_id);
 
             case self::TYPE_PIE:
                 return new ilChartPie($a_id);
 
             case self::TYPE_SPIDER:
                 return new ilChartSpider($a_id);
         }
         throw new ilException("Unknown chart type.");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShadow()

ilChart::getShadow ( )

Definition at line 173 of file class.ilChart.php.

References $shadow.

Referenced by getHTML().

                                : int
     {
         return $this->shadow;
     }

Here is the caller graph for this function:

◆ initJS()

ilChart::initJS ( )

protected

Init JS script files.

Definition at line 195 of file class.ilChart.php.

References $tpl, addCustomJS(), ILIAS\UICore\GlobalTemplate\addJavaScript(), iljQueryUtil\initjQuery(), and ILIAS\UI\examples\Chart\Bar\Horizontal\stacked().

Referenced by getHTML().

                                : void
     {
         $tpl = $this->tpl;
 
         iljQueryUtil::initjQuery();
 
         $tpl->addJavaScript("assets/js/excanvas.min.js");
         $tpl->addJavaScript("assets/js/jquery.flot.min.js");
 
         if ($this->auto_resize) {
             // #13108
             $tpl->addJavaScript("assets/js/jquery.flot.resize.min.js");
         }
 
         if ($this->stacked) {
             $tpl->addJavaScript("assets/js/jquery.flot.stack.min.js");
         }
 
         $this->addCustomJS();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValid()

ilChart::isValid ( )

protected

Basic validation.

Definition at line 81 of file class.ilChart.php.

Referenced by getHTML().

                                 : bool
     {
         if (sizeof($this->data)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isValidColor()

static ilChart::isValidColor ( string $a_value )

static

Validate html color code.

Definition at line 137 of file class.ilChart.php.

Referenced by ilChartLegend\setBackground(), ilChartData\setFill(), and ilChartLegend\setLabelBorder().

                                                         : bool
     {
         if (preg_match("/^#[0-9a-f]{3}$/i", $a_value, $match)) {
             return true;
         } elseif (preg_match("/^#[0-9a-f]{6}$/i", $a_value, $match)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isValidDataType()

ilChart::isValidDataType ( ilChartData $a_series )

abstractprotected

Validate data series.

Referenced by addData(), and getInstanceByType().

Here is the caller graph for this function:

◆ parseGlobalOptions()

ilChart::parseGlobalOptions ( stdClass $a_options )

Convert (global) properties to flot config.

Definition at line 226 of file class.ilChart.php.

Referenced by getHTML().

                                                            : void
     {
     }

Here is the caller graph for this function:

◆ renderColor()

static ilChart::renderColor	(	string	$a_value,
		float	$a_opacity = `1`
	)

static

Render html color code.

Definition at line 150 of file class.ilChart.php.

Referenced by ilChartDataSpider\parseData(), ilChartData\parseData(), ilChartDataSpider\parseGlobalOptions(), ilChartSpider\parseGlobalOptions(), ilChartDataPie\parseGlobalOptions(), and ilChartLegend\parseOptions().

      : string {
         if (self::isValidColor($a_value)) {
             if (strlen($a_value) == 4) {
                 return "rgba(" . hexdec($a_value[1] . $a_value[1]) . ", " .
                     hexdec($a_value[2] . $a_value[2]) . ", " .
                     hexdec($a_value[3] . $a_value[3]) . ", " . $a_opacity . ")";
             } else {
                 return "rgba(" . hexdec($a_value[1] . $a_value[2]) . ", " .
                     hexdec($a_value[3] . $a_value[4]) . ", " .
                     hexdec($a_value[5] . $a_value[6]) . ", " . $a_opacity . ")";
             }
         }
         return "";
     }

Here is the caller graph for this function:

◆ setAutoResize()

ilChart::setAutoResize ( bool $a_value )

Toggle auto-resizing on window resize/redraw.

Definition at line 181 of file class.ilChart.php.

      : void {
         $this->auto_resize = $a_value;
     }

◆ setColors()

ilChart::setColors ( array $a_values )

Definition at line 120 of file class.ilChart.php.

                                               : void
     {
         foreach ($a_values as $color) {
             if (self::isValidColor($color)) {
                 $this->colors[] = $color;
             }
         }
     }

◆ setLegend()

ilChart::setLegend ( ilChartLegend $a_legend )

Definition at line 115 of file class.ilChart.php.

Referenced by ilChartPie\parseGlobalOptions().

                                                       : void
     {
         $this->legend = $a_legend;
     }

Here is the caller graph for this function:

◆ setShadow()

ilChart::setShadow ( int $a_value )

Definition at line 168 of file class.ilChart.php.

Referenced by __construct().

                                            : void
     {
         $this->shadow = $a_value;
     }

Here is the caller graph for this function:

◆ setSize()

ilChart::setSize	(	string	$a_x,
		string	$a_y
	)

Set chart size.

Definition at line 92 of file class.ilChart.php.

                                                      : void
     {
         $this->width = $a_x;
         $this->height = $a_y;
     }

◆ setStacked()

ilChart::setStacked ( bool $a_value )

Definition at line 187 of file class.ilChart.php.

References ILIAS\UI\examples\Chart\Bar\Horizontal\stacked().

                                              : void
     {
         $this->stacked = $a_value;
     }

Here is the call graph for this function:

Field Documentation

◆ $auto_resize

bool ilChart::$auto_resize = false

protected

Definition at line 37 of file class.ilChart.php.

◆ $colors

array ilChart::$colors = []

protected

Definition at line 36 of file class.ilChart.php.

Referenced by getColors().

◆ $data

array ilChart::$data = []

protected

Definition at line 33 of file class.ilChart.php.

Referenced by addData().

◆ $height

string ilChart::$height = ""

protected

Definition at line 32 of file class.ilChart.php.

◆ $id

string ilChart::$id = ""

protected

Definition at line 30 of file class.ilChart.php.

◆ $legend

ilChartLegend ilChart::$legend = null

protected

Definition at line 34 of file class.ilChart.php.

Referenced by ilChartPie\parseGlobalOptions().

◆ $shadow

int ilChart::$shadow = 0

protected

Definition at line 35 of file class.ilChart.php.

Referenced by getShadow().

◆ $stacked

bool ilChart::$stacked = false

protected

Definition at line 38 of file class.ilChart.php.

Referenced by getHTML().

◆ $tpl

ilGlobalTemplateInterface ilChart::$tpl

protected

Definition at line 29 of file class.ilChart.php.

Referenced by ilChartPie\addCustomJS(), ilChartSpider\addCustomJS(), and initJS().

◆ $width

string ilChart::$width = ""

protected

Definition at line 31 of file class.ilChart.php.

◆ TYPE_GRID

const ilChart::TYPE_GRID = 1

Definition at line 25 of file class.ilChart.php.

Referenced by SurveyMetricQuestionEvaluation\getChart(), SurveyMatrixQuestionEvaluation\getChart(), SurveyQuestionEvaluation\getChart(), ilSessionStatisticsGUI\getChart(), ilLPObjectStatisticsTypesTableGUI\getGraph(), ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), ilLPObjectStatisticsLPTableGUI\getGraph(), and ilWikiStatGUI\renderGraph().

◆ TYPE_PIE

const ilChart::TYPE_PIE = 2

Definition at line 26 of file class.ilChart.php.

◆ TYPE_SPIDER

const ilChart::TYPE_SPIDER = 3

Definition at line 27 of file class.ilChart.php.

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

components/ILIAS/Chart/classes/class.ilChart.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomJS()

◆ addData()

◆ getColors()

◆ getDataInstance()

◆ getHTML()

◆ getInstanceByType()

◆ getShadow()

◆ initJS()

◆ isValid()

◆ isValidColor()

◆ isValidDataType()

◆ parseGlobalOptions()

◆ renderColor()

◆ setAutoResize()

◆ setColors()

◆ setLegend()

◆ setShadow()

◆ setSize()

◆ setStacked()

Field Documentation

◆ $auto_resize

◆ $colors

◆ $data

◆ $height

◆ $id

◆ $legend

◆ $shadow

◆ $stacked

◆ $tpl

◆ $width

◆ TYPE_GRID

◆ TYPE_PIE

◆ TYPE_SPIDER