ilChartDataPoints Class Reference

Chart data points series. More...

Inheritance diagram for ilChartDataPoints:

Collaboration diagram for ilChartDataPoints:

Public Member Functions
	setLineWidth ($a_value)
	Set line width.
	getLineWidth ()
	Get line width.
	setPointRadius ($a_value)
	Set radius.
	getPointRadius ()
	Get radius.
Public Member Functions inherited from ilChartData
	setHidden ($a_value)
	Set hidden.
	isHidden ()
	Is hidden?
	setLabel ($a_value)
	Set label.
	getLabel ()
	Get label.
	addPoint ($a_x, $a_y=null)
	Set data.
	getData ()
	Get data.
	setFill ($a_value, $a_color=null)
	Set fill.
	getFill ()
	Get fill.
	parseData (array &$a_data)
	Convert data to flot config.
	parseGlobalOptions (stdClass $a_options, ilChart $a_chart)
	Convert (global) properties to flot config.

Protected Member Functions
	getTypeString ()
	Get series type.
	parseDataOptions (array &$a_options)
	Convert data options to flot config.

Protected Attributes
	$line_width
	$radius
Protected Attributes inherited from ilChartData
	$type
	$label
	$data
	$fill
	$fill_color
	$hidden

Detailed Description

Chart data points series.

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

Member Function Documentation

ilChartDataPoints::getLineWidth

(

)

Get line width.

Returns

int

Definition at line 38 of file class.ilChartDataPoints.php.

References $line_width.

Referenced by parseDataOptions().

        {
                return $this->line_width;
        }

Here is the caller graph for this function:

ilChartDataPoints::getPointRadius

(

)

Get radius.

Returns

int

Definition at line 58 of file class.ilChartDataPoints.php.

References $radius.

Referenced by parseDataOptions().

        {
                return $this->radius;
        }       

Here is the caller graph for this function:

ilChartDataPoints::getTypeString ( )

protected

Get series type.

Returns

string

Reimplemented from ilChartData.

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

        {
                return "points";
        }

ilChartDataPoints::parseDataOptions ( array &  $a_options )

protected

Convert data options to flot config.

Parameters

array	$a_options
ilChart	$a_chart

Reimplemented from ilChartData.

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

References $radius, getLineWidth(), and getPointRadius().

        {               
                $width = $this->getLineWidth();
                if($width !== null)
                {
                        $a_options["lineWidth"] = $width;
                }
                
                $radius = $this->getPointRadius();
                if($radius !== null)
                {
                        $a_options["radius"] = $radius;
                }                               
        }

Here is the call graph for this function:

ilChartDataPoints::setLineWidth

(

$a_value

)

Set line width.

Parameters

int

$a_value

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

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

ilChartDataPoints::setPointRadius

(

$a_value

)

Set radius.

Parameters

int

$a_value

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

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

Field Documentation

ilChartDataPoints::$line_width

protected

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

Referenced by getLineWidth().

ilChartDataPoints::$radius

protected

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

Referenced by getPointRadius(), and parseDataOptions().

---

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

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