ilChartLegend Class Reference

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 20 of file class.ilChartLegend.php.

Constructor & Destructor Documentation

__construct()

ilChartLegend::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getBackground()

ilChartLegend::getBackground

(

)

Get background color.

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

References $background.

Referenced by parseOptions().

                                   : string
    {
        return $this->background;
    }

Here is the caller graph for this function:

getColumns()

ilChartLegend::getColumns

(

)

Get number of columns.

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

References $columns.

Referenced by parseOptions().

                                : int
    {
        return $this->columns;
    }

Here is the caller graph for this function:

getContainer()

ilChartLegend::getContainer

(

)

Get container id.

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

References $container.

Referenced by parseOptions().

                                  : string
    {
        return $this->container;
    }

Here is the caller graph for this function:

getLabelBorder()

ilChartLegend::getLabelBorder

(

)

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

References $border.

Referenced by parseOptions().

                                    : string
    {
        return $this->border;
    }

Here is the caller graph for this function:

getMargin()

ilChartLegend::getMargin

(

)

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

Referenced by parseOptions().

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

Here is the caller graph for this function:

getOpacity()

ilChartLegend::getOpacity

(

)

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

References $opacity.

Referenced by parseOptions().

                                : float
    {
        return $this->opacity;
    }

Here is the caller graph for this function:

getPosition()

ilChartLegend::getPosition

(

)

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

References $position.

Referenced by parseOptions().

                                 : string
    {
        return $this->position;
    }

Here is the caller graph for this function:

parseOptions()

ilChartLegend::parseOptions

(

stdClass

$a_options

)

Convert (global) properties to flot config.

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

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

                                                     : 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;
        }
    }

Here is the call graph for this function:

setBackground()

ilChartLegend::setBackground

(

string

$a_color

)

Set background color.

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

References ilChart\isValidColor().

Referenced by __construct().

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

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 57 of file class.ilChartLegend.php.

Referenced by __construct().

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

Here is the caller graph for this function:

setContainer()

ilChartLegend::setContainer

(

string

$a_value

)

Set container id.

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

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

setLabelBorder()

ilChartLegend::setLabelBorder

(

string

$a_color

)

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

References ilChart\isValidColor().

Referenced by __construct().

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

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 70 of file class.ilChartLegend.php.

Referenced by __construct().

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

Here is the caller graph for this function:

setOpacity()

ilChartLegend::setOpacity

(

float

$a_value

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

setPosition()

ilChartLegend::setPosition

(

string

$a_position

)

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

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

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

Here is the caller graph for this function:

Field Documentation

$background

string ilChartLegend::$background = ""

protected

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

Referenced by getBackground().

$border

string ilChartLegend::$border = ""

protected

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

Referenced by getLabelBorder().

$columns

int ilChartLegend::$columns = 0

protected

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

Referenced by getColumns().

$container

string ilChartLegend::$container = ""

protected

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

Referenced by getContainer(), and parseOptions().

$margin_x

int ilChartLegend::$margin_x = 0

protected

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

$margin_y

int ilChartLegend::$margin_y = 0

protected

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

$opacity

float ilChartLegend::$opacity = 0

protected

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

Referenced by getOpacity().

$position

string ilChartLegend::$position = ""

protected

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

Referenced by getPosition().

---

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

• Services/Chart/classes/class.ilChartLegend.php