Generator for grid-based charts. More...

Inheritance diagram for ilChartGrid:

Collaboration diagram for ilChartGrid:

Public Member Functions
	getDataInstance ($a_type=null)
	Get data series instance. More...

	setTicks ($a_x, $a_y, $a_labeled=false)
	Set ticks. More...

	getTicks ()
	Get ticks. More...

	setYAxisToInteger ($a_status)
	Restrict y-axis to integer values. More...

	setXAxisToInteger ($a_status)
	Restrict x-axis to integer values. More...

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

Public Member Functions inherited from ilChart
	getDataInstance ($a_type=null)
	Get data series instance. More...

	setSize ($a_x, $a_y)
	Set chart size. More...

	addData (ilChartData $a_series, $a_idx=null)
	Add data series. More...

	setLegend (ilChartLegend $a_legend)
	Set chart legend. More...

	setColors ($a_values)
	Set colors. More...

	getColors ()
	Get colors. More...

	setShadow ($a_value)
	Set shadow. More...

	getShadow ()
	Get shadow. More...

	setAutoResize ($a_value)
	Toggle auto-resizing on window resize/redraw. More...

	setStacked ($a_value)
	Toggle stacking. More...

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

	getHTML ()
	Render. More...

Data Fields
const	DATA_LINES = 1

const	DATA_BARS = 2

const	DATA_POINTS = 3

Data Fields inherited from ilChart
const	TYPE_GRID = 1

const	TYPE_PIE = 2

const	TYPE_SPIDER = 3

Protected Member Functions
	__construct ($a_id)
	Constructor. More...

	isValidDataType (ilChartData $a_series)
	Validate data series. More...

Protected Member Functions inherited from ilChart
	__construct ($a_id)
	Constructor. More...

	isValidDataType (ilChartData $a_series)
	Validate data series. More...

	isValid ()
	Basic validation. More...

	initJS ()
	Init JS script files. More...

	addCustomJS ()
	Add type-specific JS script. More...

Protected Attributes
	$ticks

	$integer_axis

Protected Attributes inherited from ilChart
	$tpl

	$id

	$width

	$height

	$data

	$legend

	$shadow

	$colors

	$auto_resize

	$stacked

Additional Inherited Members
Static Public Member Functions inherited from ilChart
static	getInstanceByType ($a_type, $a_id)
	Get type instance. More...

static	isValidColor ($a_value)
	Validate html color code. More...

static	renderColor ($a_value, $a_opacity=1)
	Render html color code. More...

Detailed Description

Generator for grid-based charts.

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 13 of file class.ilChartGrid.php.

Constructor & Destructor Documentation

◆ __construct()

ilChartGrid::__construct ( $a_id )

protected

Constructor.

Parameters

string $a_id

Reimplemented from ilChart.

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

    {
        parent::__construct($a_id);
        
        $this->setXAxisToInteger(false);
        $this->setYAxisToInteger(false);
    }

References setXAxisToInteger(), and setYAxisToInteger().

Here is the call graph for this function:

Member Function Documentation

◆ getDataInstance()

ilChartGrid::getDataInstance ( $a_type = null )

Get data series instance.

Returns: ilChartData

Reimplemented from ilChart.

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

    {
        switch ($a_type) {
            case self::DATA_BARS:
                include_once "Services/Chart/classes/class.ilChartDataBars.php";
                return new ilChartDataBars();
                
            case self::DATA_POINTS:
                include_once "Services/Chart/classes/class.ilChartDataPoints.php";
                return new ilChartDataPoints();
            
            default:
            case self::DATA_LINES:
                include_once "Services/Chart/classes/class.ilChartDataLines.php";
                return new ilChartDataLines();
        }
    }

References $a_type, DATA_BARS, DATA_LINES, and DATA_POINTS.

◆ getTicks()

ilChartGrid::getTicks ( )

Get ticks.

Returns: array (x, y)

Definition at line 75 of file class.ilChartGrid.php.

    {
        return $this->ticks;
    }

References $ticks.

Referenced by parseGlobalOptions().

Here is the caller graph for this function:

◆ isValidDataType()

ilChartGrid::isValidDataType ( ilChartData $a_series )

protected

Validate data series.

Returns: bool

Reimplemented from ilChart.

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

    {
        if ($a_series instanceof ilChartDataLines
            || $a_series instanceof ilChartDataBars
            || $a_series instanceof ilChartDataPoints) {
            return true;
        }
        return false;
    }

◆ parseGlobalOptions()

ilChartGrid::parseGlobalOptions ( stdClass $a_options )

Convert (global) properties to flot config.

Parameters

object $a_options

Reimplemented from ilChart.

Definition at line 100 of file class.ilChartGrid.php.

    {
        // axis/ticks
        $tmp = array();
        $ticks = $this->getTicks();
        if ($ticks) {
            $labeled = (bool) $ticks["labeled"];
            unset($ticks["labeled"]);
            foreach ($ticks as $axis => $def) {
                if (is_numeric($def) || is_array($def)) {
                    $a_options->{$axis . "axis"} = new stdClass();
                }
                if (is_numeric($def)) {
                    $a_options->{$axis . "axis"}->ticks = $def;
                } elseif (is_array($def)) {
                    $a_options->{$axis . "axis"}->ticks = array();
                    foreach ($def as $idx => $value) {
                        if ($labeled) {
                            $a_options->{$axis . "axis"}->ticks[] = array($idx, $value);
                        } else {
                            $a_options->{$axis . "axis"}->ticks[] = $value;
                        }
                    }
                }
            }
        }
        
        // optional: remove decimals
        if ($this->integer_axis["x"] && !isset($a_options->xaxis)) {
            $a_options->{"xaxis"} = new stdClass();
            $a_options->{"xaxis"}->tickDecimals = 0;
        }
        if ($this->integer_axis["y"] && !isset($a_options->yaxis)) {
            $a_options->{"yaxis"} = new stdClass();
            $a_options->{"yaxis"}->tickDecimals = 0;
        }
    }

References $axis, $def, $ticks, and getTicks().

Here is the call graph for this function:

◆ setTicks()

ilChartGrid::setTicks	(	$a_x,
		$a_y,
		$a_labeled = `false`
	)

Set ticks.

Parameters

int \| array	$a_x
int \| array	$a_y
bool	$a_labeled

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

    {
        $this->ticks = array("x" => $a_x, "y" => $a_y, "labeled" => (bool) $a_labeled);
    }

◆ setXAxisToInteger()

ilChartGrid::setXAxisToInteger ( $a_status )

Restrict x-axis to integer values.

Parameters

bool $a_status

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

    {
        $this->integer_axis["x"] = (bool) $a_status;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setYAxisToInteger()

ilChartGrid::setYAxisToInteger ( $a_status )

Restrict y-axis to integer values.

Parameters

bool $a_status

Definition at line 85 of file class.ilChartGrid.php.

    {
        $this->integer_axis["y"] = (bool) $a_status;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $integer_axis

ilChartGrid::$integer_axis

protected

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

◆ $ticks

ilChartGrid::$ticks

protected

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

Referenced by getTicks(), and parseGlobalOptions().

◆ DATA_BARS

const ilChartGrid::DATA_BARS = 2

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

Referenced by SurveyMatrixQuestionEvaluation\getChart(), SurveyMetricQuestionEvaluation\getChart(), SurveyQuestionEvaluation\getChart(), getDataInstance(), and ilWikiStatGUI\renderGraph().

◆ DATA_LINES

const ilChartGrid::DATA_LINES = 1

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

Referenced by ilSessionStatisticsGUI\getChart(), getDataInstance(), ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), ilLPObjectStatisticsTypesTableGUI\getGraph(), and ilWikiStatGUI\renderGraph().

◆ DATA_POINTS

const ilChartGrid::DATA_POINTS = 3

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

Referenced by getDataInstance().

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

Services/Chart/classes/class.ilChartGrid.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDataInstance()

◆ getTicks()

◆ isValidDataType()

◆ parseGlobalOptions()

◆ setTicks()

◆ setXAxisToInteger()

◆ setYAxisToInteger()

Field Documentation

◆ $integer_axis

◆ $ticks

◆ DATA_BARS

◆ DATA_LINES

◆ DATA_POINTS