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

Inheritance diagram for ilChartDataPie:

Collaboration diagram for ilChartDataPie:

Public Member Functions
	setLineWidth (int $a_value)

	getLineWidth ()

	setLabelRadius (float $a_value)
	Sets the radius at which to place the labels. More...

	getLabelRadius ()

	addPiePoint (int $a_value, ?string $a_caption=null)

	parseData (array &$a_data)
	Convert data to flot config. More...

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

Public Member Functions inherited from ilChartData
	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 ()

Protected Member Functions inherited from ilChartData
	getTypeString ()

	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...

Protected Attributes
int	$line_width = 0

float	$label_radius = 0

Protected Attributes inherited from ilChartData
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 Chart data pie series

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.ilChartDataPie.php.

Member Function Documentation

◆ addPiePoint()

ilChartDataPie::addPiePoint	(	int	$a_value,
		?string	$a_caption = `null`
	)

Definition at line 58 of file class.ilChartDataPie.php.

                                                                        : void
    {
        $this->data[] = array($a_value, $a_caption);
    }

◆ getLabelRadius()

ilChartDataPie::getLabelRadius ( )

Definition at line 53 of file class.ilChartDataPie.php.

                                    : float
    {
        return $this->label_radius;
    }

References $label_radius.

Referenced by parseData().

Here is the caller graph for this function:

◆ getLineWidth()

ilChartDataPie::getLineWidth ( )

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

                                  : int
    {
        return $this->line_width;
    }

References $line_width.

◆ getTypeString()

ilChartDataPie::getTypeString ( )

protected

Reimplemented from ilChartData.

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

                                      : string
    {
        return "pie";
    }

Referenced by parseData().

Here is the caller graph for this function:

◆ parseData()

ilChartDataPie::parseData ( array & $a_data )

Convert data to flot config.

Reimplemented from ilChartData.

Definition at line 63 of file class.ilChartDataPie.php.

                                             : void
    {
        foreach ($this->data as $slice) {
            $series = new stdClass();
            $series->label = str_replace("\"", "\\\"", $slice[1]);
 
            // add percentage to legend
            if (!$this->getLabelRadius()) {
                $series->label .= " (" . $slice[0] . "%)";
            }
 
            $series->data = $slice[0];
 
            $options = array("show" => !$this->isHidden());
 
            $series->{$this->getTypeString()} = $options;
 
            $a_data[] = $series;
        }
    }

References getLabelRadius(), getTypeString(), and ilChartData\isHidden().

Here is the call graph for this function:

◆ parseGlobalOptions()

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

Convert (global) properties to flot config.

Reimplemented from ilChartData.

Definition at line 84 of file class.ilChartDataPie.php.

                                                                             : void
    {
        $a_options->series->pie = new stdClass();
        $a_options->series->pie->show = true;
 
        // fill vs. stroke - trying to normalize data attributes
 
        $fill = $this->getFill();
        $width = $this->getLineWidth();
        if ($fill["fill"] || $width) {
            $a_options->series->pie->stroke = new stdClass();
            if ($width) {
                $a_options->series->pie->stroke->width = $width;
            }
            if ($fill["color"]) {
                $a_options->series->pie->stroke->color = ilChart::renderColor($fill["color"], $fill["fill"]);
            }
        }
 
        $radius = $this->getLabelRadius();
        if ($radius) {
            $a_options->series->pie->label = new stdClass();
            $a_options->series->pie->label->background = new stdClass();
            $a_options->series->pie->radius = 1;
            $a_options->series->pie->label->radius = $radius;
            $a_options->series->pie->label->show = true;
            $a_options->series->pie->label->background->color = "#444";
            $a_options->series->pie->label->background->opacity = 0.8;
        }
    }

References ilChart\renderColor().

Here is the call graph for this function:

◆ setLabelRadius()

ilChartDataPie::setLabelRadius ( float $a_value )

Sets the radius at which to place the labels.

If value is between 0 and 1 (inclusive) then it will use that as a percentage of the available space (size of the container), otherwise it will use the value as a direct pixel length.

Definition at line 48 of file class.ilChartDataPie.php.

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

◆ setLineWidth()

ilChartDataPie::setLineWidth ( int $a_value )

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

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

Field Documentation

◆ $label_radius

float ilChartDataPie::$label_radius = 0

protected

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

Referenced by getLabelRadius().

◆ $line_width

int ilChartDataPie::$line_width = 0

protected

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

Referenced by getLineWidth().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addPiePoint()

◆ getLabelRadius()

◆ getLineWidth()

◆ getTypeString()

◆ parseData()

◆ parseGlobalOptions()

◆ setLabelRadius()

◆ setLineWidth()

Field Documentation

◆ $label_radius

◆ $line_width