ilChartData Class Reference

Abstract chart data series base class. More...

Inheritance diagram for ilChartData:

Collaboration diagram for ilChartData:

Public Member Functions
	setHidden ($a_value)
	Set hidden. More...
	isHidden ()
	Is hidden? More...
	setLabel ($a_value)
	Set label. More...
	getLabel ()
	Get label. More...
	addPoint ($a_x, $a_y=null)
	Set data. More...
	getData ()
	Get data. More...
	setFill ($a_value, $a_color=null)
	Set fill. More...
	getFill ()
	Get fill. More...
	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 ()
	Get series type. More...
	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...

Protected Attributes
	$type
	$label
	$data
	$fill
	$fill_color
	$hidden

Detailed Description

Abstract chart data series base class.

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

Member Function Documentation

addPoint()

ilChartData::addPoint	(		$a_x,
			$a_y = null
	)

Set data.

Parameters

float	$a_x
float	$a_y

Reimplemented in ilChartDataPie.

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

    {
        if ($a_y !== null) {
            $this->data[] = array($a_x, $a_y);
        } else {
            $this->data[] = $a_x;
        }
    }

References data.

getData()

ilChartData::getData

(

)

Get data.

Returns

array

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

    {
        return $this->data;
    }

References $data.

Referenced by parseData().

Here is the caller graph for this function:

getFill()

ilChartData::getFill

(

)

Get fill.

Returns

array (fill, color)

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

    {
        return array("fill"=>$this->fill, "color"=>$this->fill_color);
    }

Referenced by parseData(), and ilChartDataSpider\parseData().

Here is the caller graph for this function:

getLabel()

ilChartData::getLabel

(

)

Get label.

Returns

string

Definition at line 62 of file class.ilChartData.php.

    {
        return $this->label;
    }

References $label.

Referenced by parseData().

Here is the caller graph for this function:

getTypeString()

ilChartData::getTypeString ( )

abstractprotected

Get series type.

Returns

string

Reimplemented in ilChartDataBars, ilChartDataLines, ilChartDataPie, ilChartDataPoints, and ilChartDataSpider.

Referenced by parseData().

Here is the caller graph for this function:

isHidden()

ilChartData::isHidden

(

)

Is hidden?

Returns

bool

Definition at line 42 of file class.ilChartData.php.

    {
        return $this->hidden;
    }

References $hidden.

Referenced by parseData(), and ilChartDataPie\parseData().

Here is the caller graph for this function:

parseData()

ilChartData::parseData

(

array &

$a_data

)

Convert data to flot config.

Parameters

array

$a_data

Returns

object

Reimplemented in ilChartDataPie, and ilChartDataSpider.

Definition at line 132 of file class.ilChartData.php.

    {
        $series = new stdClass();
        $series->label = str_replace("\"", "\\\"", $this->getLabel());
        
        $series->data = array();
        foreach ($this->getData() as $point) {
            $series->data[] = array($point[0], $point[1]);
        }
            
        $options = array("show"=>($this->isHidden() ? false : true));
                
        $fill = $this->getFill();
        if ($fill["fill"]) {
            $options["fill"] = $fill["fill"];
            if ($fill["color"]) {
                $options["fillColor"] = ilChart::renderColor($fill["color"], $fill["fill"]);
            }
        }
        
        $this->parseDataOptions($options);
        
        $series->{$this->getTypeString()} = $options;
        
        $a_data[] = $series;
    }

References $fill, $options, $series, getData(), getFill(), getLabel(), getTypeString(), isHidden(), parseDataOptions(), and ilChart\renderColor().

Here is the call graph for this function:

parseDataOptions()

ilChartData::parseDataOptions ( array &  $a_options )

protected

Convert data options to flot config.

Parameters

array	$a_options
ilChart	$a_chart

Reimplemented in ilChartDataBars, ilChartDataLines, and ilChartDataPoints.

Definition at line 122 of file class.ilChartData.php.

    {
    }

Referenced by parseData().

Here is the caller graph for this function:

parseGlobalOptions()

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

Convert (global) properties to flot config.

Parameters

object	$a_options
ilChart	$a_chart

Reimplemented in ilChartDataPie, and ilChartDataSpider.

Definition at line 165 of file class.ilChartData.php.

    {
    }

setFill()

ilChartData::setFill	(		$a_value,
			$a_color = null
	)

Set fill.

Parameters

float	$a_value
string	$a_color

Definition at line 98 of file class.ilChartData.php.

    {
        $this->fill = $a_value;
        if (ilChart::isValidColor($a_color)) {
            $this->fill_color = $a_color;
        }
    }

References ilChart\isValidColor().

Here is the call graph for this function:

setHidden()

ilChartData::setHidden

(

$a_value

)

Set hidden.

Parameters

bool

$a_value

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

    {
        $this->hidden = (bool) $a_value;
    }

setLabel()

ilChartData::setLabel

(

$a_value

)

Set label.

Parameters

string

$a_value

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

    {
        $this->label = (string) $a_value;
    }

Field Documentation

$data

ilChartData::$data

protected

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

Referenced by getData().

$fill

ilChartData::$fill

protected

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

Referenced by parseData(), and ilChartDataSpider\parseData().

$fill_color

ilChartData::$fill_color

protected

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

$hidden

ilChartData::$hidden

protected

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

Referenced by isHidden().

$label

ilChartData::$label

protected

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

Referenced by getLabel(), and ilChartDataSpider\parseGlobalOptions().

$type

ilChartData::$type

protected

Definition at line 13 of file class.ilChartData.php.

---

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

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