ilChartLegend Class Reference

Chart legend. More...

Collaboration diagram for ilChartLegend:

Public Member Functions
	__construct ()
	Constructor. More...
	setPosition ($a_position)
	Set Position. More...
	getPosition ()
	Get Position. More...
	setColumns ($a_value)
	Set number of columns. More...
	getColumns ()
	Get number of columns. More...
	setMargin ($a_x, $a_y)
	Set margins. More...
	getMargin ()
	Get margins. More...
	setBackground ($a_color)
	Set background color. More...
	getBackground ()
	Get background color. More...
	setOpacity ($a_value)
	Set Opacity. More...
	getOpacity ()
	Get opacity. More...
	setLabelBorder ($a_color)
	Set label border. More...
	getLabelBorder ()
	Get label border. More...
	setContainer ($a_value)
	Set container id. More...
	getContainer ()
	Get container id. More...
	parseOptions (stdClass $a_options)
	Convert (global) properties to flot config. More...

Protected Attributes
	$position
	$columns
	$margin_x
	$margin_y
	$background
	$opacity
	$border
	$container

Detailed Description

Chart legend.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilChartLegend::__construct

(

)

Constructor.

Definition at line 25 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.

Returns

string

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

    {
        return $this->background;
    }

References $background.

Referenced by parseOptions().

Here is the caller graph for this function:

getColumns()

ilChartLegend::getColumns

(

)

Get number of columns.

Returns

int

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

    {
        return $this->columns;
    }

References $columns.

Referenced by parseOptions().

Here is the caller graph for this function:

getContainer()

ilChartLegend::getContainer

(

)

Get container id.

Returns

string

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

    {
        return $this->container;
    }

References $container.

Referenced by parseOptions().

Here is the caller graph for this function:

getLabelBorder()

ilChartLegend::getLabelBorder

(

)

Get label border.

Returns

string

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

    {
        return $this->border;
    }

References $border.

Referenced by parseOptions().

Here is the caller graph for this function:

getMargin()

ilChartLegend::getMargin

(

)

Get margins.

Returns

array (x, y)

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

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

Referenced by parseOptions().

Here is the caller graph for this function:

getOpacity()

ilChartLegend::getOpacity

(

)

Get opacity.

Returns

float

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

    {
        return $this->opacity;
    }

References $opacity.

Referenced by parseOptions().

Here is the caller graph for this function:

getPosition()

ilChartLegend::getPosition

(

)

Get Position.

Returns

string

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

    {
        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.

Parameters

object

$a_options

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

    {
        $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(",", ".", $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

(

$a_color

)

Set background color.

Parameters

string

$a_color

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

    {
        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

(

$a_value

)

Set number of columns.

Parameters

int

$a_value

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

    {
        $this->columns = (int) $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

setContainer()

ilChartLegend::setContainer

(

$a_value

)

Set container id.

Parameters

string

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

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

setLabelBorder()

ilChartLegend::setLabelBorder

(

$a_color

)

Set label border.

Parameters

string

$a_color

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

    {
        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	(		$a_x,
			$a_y
	)

Set margins.

Parameters

int	$a_x
int	$a_y

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

    {
        $this->margin_x = (int) $a_x;
        $this->margin_y = (int) $a_y;
    }

Referenced by __construct().

Here is the caller graph for this function:

setOpacity()

ilChartLegend::setOpacity

(

$a_value

)

Set Opacity.

Parameters

float

$a_value

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

    {
        $a_value = (float) $a_value;
        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

(

$a_position

)

Set Position.

Parameters

string

$position

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

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

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$background

ilChartLegend::$background

protected

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

Referenced by getBackground().

$border

ilChartLegend::$border

protected

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

Referenced by getLabelBorder().

$columns

ilChartLegend::$columns

protected

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

Referenced by getColumns().

$container

ilChartLegend::$container

protected

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

Referenced by getContainer(), and parseOptions().

$margin_x

ilChartLegend::$margin_x

protected

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

$margin_y

ilChartLegend::$margin_y

protected

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

$opacity

ilChartLegend::$opacity

protected

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

Referenced by getOpacity().

$position

ilChartLegend::$position

protected

Definition at line 13 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