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

Collaboration diagram for ilChartLegend:

Public Member Functions
	__construct ()

	setPosition (string $a_position)

	getPosition ()

	setColumns (int $a_value)
	Set number of columns. More...

	getColumns ()
	Get number of columns. More...

	setMargin (int $a_x, int $a_y)

	getMargin ()

	setBackground (string $a_color)
	Set background color. More...

	getBackground ()
	Get background color. More...

	setOpacity (float $a_value)

	getOpacity ()

	setLabelBorder (string $a_color)

	getLabelBorder ()

	setContainer (string $a_value)
	Set container id. More...

	getContainer ()
	Get container id. More...

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

Protected Attributes
string	$position = ""

int	$columns = 0

int	$margin_x = 0

int	$margin_y = 0

string	$background = ""

float	$opacity = 0

string	$border = ""

string	$container = ""

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 legend

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

Constructor & Destructor Documentation

◆ __construct()

ilChartLegend::__construct ( )

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

    {
        $this->setPosition("ne");
        $this->setColumns(1);
        $this->setMargin(5, 5);
        $this->setBackground("#888");
        $this->setOpacity(0.1);
        $this->setLabelBorder("#bbb");
    }

References setBackground(), setColumns(), setLabelBorder(), setMargin(), setOpacity(), and setPosition().

Here is the call graph for this function:

Member Function Documentation

◆ getBackground()

ilChartLegend::getBackground ( )

Get background color.

Definition at line 97 of file class.ilChartLegend.php.

                                   : string
    {
        return $this->background;
    }

References $background.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getColumns()

ilChartLegend::getColumns ( )

Get number of columns.

Definition at line 68 of file class.ilChartLegend.php.

                                : int
    {
        return $this->columns;
    }

References $columns.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getContainer()

ilChartLegend::getContainer ( )

Get container id.

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

                                  : string
    {
        return $this->container;
    }

References $container.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getLabelBorder()

ilChartLegend::getLabelBorder ( )

Definition at line 121 of file class.ilChartLegend.php.

                                    : string
    {
        return $this->border;
    }

References $border.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getMargin()

ilChartLegend::getMargin ( )

Definition at line 79 of file class.ilChartLegend.php.

                               : array
    {
        return array("x" => $this->margin_x, "y" => $this->margin_y);
    }

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getOpacity()

ilChartLegend::getOpacity ( )

Definition at line 109 of file class.ilChartLegend.php.

                                : float
    {
        return $this->opacity;
    }

References $opacity.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ getPosition()

ilChartLegend::getPosition ( )

Definition at line 52 of file class.ilChartLegend.php.

                                 : string
    {
        return $this->position;
    }

References $position.

Referenced by parseOptions().

Here is the caller graph for this function:

◆ parseOptions()

ilChartLegend::parseOptions ( stdClass $a_options )

Convert (global) properties to flot config.

Definition at line 145 of file class.ilChartLegend.php.

                                                     : void
    {
        $a_options->show = true;
 
        $a_options->noColumns = $this->getColumns();
        $a_options->position = $this->getPosition();
 
        $margin = $this->getMargin();
        $a_options->margin = array($margin["x"], $margin["y"]);
 
        $a_options->backgroundColor = ilChart::renderColor($this->getBackground());
        $a_options->backgroundOpacity = str_replace(",", ".", (string) $this->getOpacity());
        $a_options->labelBoxBorderColor = ilChart::renderColor($this->getLabelBorder());
 
        $container = $this->getContainer();
        if ($container) {
            $a_options->container = '#' . $container;
        }
    }

References $container, getBackground(), getColumns(), getContainer(), getLabelBorder(), getMargin(), getOpacity(), getPosition(), and ilChart\renderColor().

Here is the call graph for this function:

◆ setBackground()

ilChartLegend::setBackground ( string $a_color )

Set background color.

Definition at line 87 of file class.ilChartLegend.php.

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

References ilChart\isValidColor().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColumns()

ilChartLegend::setColumns ( int $a_value )

Set number of columns.

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setContainer()

ilChartLegend::setContainer ( string $a_value )

Set container id.

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

                                                 : void
    {
        $this->container = trim($a_value);
    }

◆ setLabelBorder()

ilChartLegend::setLabelBorder ( string $a_color )

Definition at line 114 of file class.ilChartLegend.php.

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

References ilChart\isValidColor().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMargin()

ilChartLegend::setMargin	(	int	$a_x,
		int	$a_y
	)

Definition at line 73 of file class.ilChartLegend.php.

                                                 : void
    {
        $this->margin_x = $a_x;
        $this->margin_y = $a_y;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setOpacity()

ilChartLegend::setOpacity ( float $a_value )

Definition at line 102 of file class.ilChartLegend.php.

                                              : void
    {
        if ($a_value >= 0 && $a_value <= 1) {
            $this->opacity = $a_value;
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setPosition()

ilChartLegend::setPosition ( string $a_position )

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

                                                   : void
    {
        $all = array("ne", "nw", "se", "sw");
        if (in_array($a_position, $all)) {
            $this->position = $a_position;
        }
    }

Referenced by __construct(), and ilChartPie\parseGlobalOptions().

Here is the caller graph for this function:

Field Documentation

◆ $background

string ilChartLegend::$background = ""

protected

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

Referenced by getBackground().

◆ $border

string ilChartLegend::$border = ""

protected

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

Referenced by getLabelBorder().

◆ $columns

int ilChartLegend::$columns = 0

protected

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

Referenced by getColumns().

◆ $container

string ilChartLegend::$container = ""

protected

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

Referenced by getContainer(), and parseOptions().

◆ $margin_x

int ilChartLegend::$margin_x = 0

protected

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

◆ $margin_y

int ilChartLegend::$margin_y = 0

protected

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

◆ $opacity

float ilChartLegend::$opacity = 0

protected

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

Referenced by getOpacity().

◆ $position

string ilChartLegend::$position = ""

protected

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

Referenced by getPosition().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBackground()

◆ getColumns()

◆ getContainer()

◆ getLabelBorder()

◆ getMargin()

◆ getOpacity()

◆ getPosition()

◆ parseOptions()

◆ setBackground()

◆ setColumns()

◆ setContainer()

◆ setLabelBorder()

◆ setMargin()

◆ setOpacity()

◆ setPosition()

Field Documentation

◆ $background

◆ $border

◆ $columns

◆ $container

◆ $margin_x

◆ $margin_y

◆ $opacity

◆ $position