ilChartData Class Reference

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

Inheritance diagram for ilChartData:

Collaboration diagram for ilChartData:

Public Member Functions
	setHidden (bool $a_value)
	isHidden ()
	setLabel (string $a_value)
	getLabel ()
	addPoint (float $a_x, ?float $a_y=null)
	Set data. More...
	getData ()
	Get data. More...
	setFill (float $a_value, string $a_color="")
	getFill ()
	parseData (array &$a_data)
	Convert data to flot config. More...
	parseGlobalOptions (stdClass $a_options, ilChart $a_chart)
	Convert (global) properties to flot config. More...

Protected Member Functions
	getTypeString ()
	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...

Protected Attributes
string	$type = ""
string	$label = ""
array	$data = []
float	$fill = 0
string	$fill_color = ""
bool	$hidden = 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 data series 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.ilChartData.php.

Member Function Documentation

addPoint()

ilChartData::addPoint	(	float	$a_x,
		?float	$a_y = null
	)

Set data.

Parameters

float	$a_x
float	$a_y

Definition at line 60 of file class.ilChartData.php.

References null.

     : void {
        if ($a_y !== null) {
            $this->data[] = array($a_x, $a_y);
        } else {
            $this->data[] = $a_x;
        }
    }

getData()

ilChartData::getData

(

)

Get data.

Returns

array

Definition at line 76 of file class.ilChartData.php.

References $data.

Referenced by parseData().

                             : array
    {
        return $this->data;
    }

Here is the caller graph for this function:

getFill()

ilChartData::getFill

(

)

Definition at line 91 of file class.ilChartData.php.

Referenced by ilChartDataSpider\parseData(), parseData(), and ilChartDataPie\parseGlobalOptions().

                             : array
    {
        return array("fill" => $this->fill, "color" => $this->fill_color);
    }

Here is the caller graph for this function:

getLabel()

ilChartData::getLabel

(

)

Definition at line 49 of file class.ilChartData.php.

References $label.

Referenced by parseData().

                              : string
    {
        return $this->label;
    }

Here is the caller graph for this function:

getTypeString()

ilChartData::getTypeString ( )

abstractprotected

Referenced by parseData().

Here is the caller graph for this function:

isHidden()

ilChartData::isHidden

(

)

Definition at line 39 of file class.ilChartData.php.

References $hidden.

Referenced by ilChartDataPie\parseData(), and parseData().

                              : bool
    {
        return $this->hidden;
    }

Here is the caller graph for this function:

parseData()

ilChartData::parseData

(

array &

$a_data

)

Convert data to flot config.

Definition at line 106 of file class.ilChartData.php.

References getData(), getFill(), getLabel(), getTypeString(), isHidden(), parseDataOptions(), and ilChart\renderColor().

                                             : void
    {
        $series = new stdClass();
        $series->label = str_replace("\"", "\\\"", $this->getLabel());

        $series->data = array();
        foreach ($this->getData() as $point) {
            if (is_array($point)) {
                $series->data[] = array($point[0], $point[1]);
            } else {
                $series->data[] = $point;
            }
        }

        $options = array("show" => !$this->isHidden());

        $fill = $this->getFill();
        if ($fill["fill"]) {
            $options["fill"] = $fill["fill"];
            if ($fill["color"]) {
                $options["fillColor"] = ilChart::renderColor($fill["color"], $fill["fill"]);
            }
        }

        $this->parseDataOptions($options);

        $series->{$this->getTypeString()} = $options;

        $a_data[] = $series;
    }

Here is the call graph for this function:

parseDataOptions()

ilChartData::parseDataOptions ( array &  $a_options )

protected

Convert data options to flot config.

Definition at line 99 of file class.ilChartData.php.

Referenced by parseData().

                                                          : void
    {
    }

Here is the caller graph for this function:

parseGlobalOptions()

ilChartData::parseGlobalOptions	(	stdClass	$a_options,
		ilChart	$a_chart
	)

Convert (global) properties to flot config.

Definition at line 140 of file class.ilChartData.php.

                                                                             : void
    {
    }

setFill()

ilChartData::setFill	(	float	$a_value,
		string	$a_color = ""
	)

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

References ilChart\isValidColor().

     : void {
        $this->fill = $a_value;
        if (ilChart::isValidColor($a_color)) {
            $this->fill_color = $a_color;
        }
    }

Here is the call graph for this function:

setHidden()

ilChartData::setHidden

(

bool

$a_value

)

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

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

setLabel()

ilChartData::setLabel

(

string

$a_value

)

Definition at line 44 of file class.ilChartData.php.

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

Field Documentation

$data

array ilChartData::$data = []

protected

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

Referenced by getData().

$fill

float ilChartData::$fill = 0

protected

Definition at line 28 of file class.ilChartData.php.

Referenced by ilChartDataSpider\parseData(), and ilChartDataPie\parseGlobalOptions().

$fill_color

string ilChartData::$fill_color = ""

protected

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

$hidden

bool ilChartData::$hidden = false

protected

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

Referenced by isHidden().

$label

string ilChartData::$label = ""

protected

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

Referenced by getLabel(), and ilChartDataSpider\parseGlobalOptions().

$type

string ilChartData::$type = ""

protected

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

---

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

• components/ILIAS/Chart/classes/class.ilChartData.php