ilChartSpider Class Reference

Generator for spider charts. More...

Inheritance diagram for ilChartSpider:

Collaboration diagram for ilChartSpider:

Public Member Functions
	getDataInstance ($a_type=null)
	Get data series instance.
	setLegLabels ($a_val)
	Set leg labels.
	getLegLabels ()
	Get leg labels.
	setYAxisMax ($a_val)
	Set y axis max value.
	getYAxisMax ()
	Get y axis max value.
	parseGlobalOptions (stdClass $a_options)
	Convert (global) properties to flot config.
Public Member Functions inherited from ilChart
	setSize ($a_x, $a_y)
	Set chart size.
	addData (ilChartData $a_series, $a_idx=null)
	Add data series.
	setLegend (ilChartLegend $a_legend)
	Set chart legend.
	setColors ($a_values)
	Set colors.
	getColors ()
	Get colors.
	setShadow ($a_value)
	Set shadow.
	getShadow ()
	Get shadow.
	setAutoResize ($a_value)
	Toggle auto-resizing on window resize/redraw.
	getHTML ()
	Render.

Protected Member Functions
	isValidDataType (ilChartData $a_series)
	Validate data series.
	addCustomJS ()
	Add type-specific JS script.
Protected Member Functions inherited from ilChart
	__construct ($a_id)
	Constructor.
	isValid ()
	Basic validation.
	initJS ()
	Init JS script files.

Protected Attributes
	$leg_labels = array()
	$y_max = 0
Protected Attributes inherited from ilChart
	$id
	$width
	$height
	$data
	$legend
	$shadow
	$colors
	$auto_resize

Additional Inherited Members
Static Public Member Functions inherited from ilChart
static	getInstanceByType ($a_type, $a_id)
	Get type instance.
static	isValidColor ($a_value)
	Validate html color code.
static	renderColor ($a_value, $a_opacity=1)
	Render html color code.
Data Fields inherited from ilChart
const	TYPE_GRID = 1
const	TYPE_PIE = 2
const	TYPE_SPIDER = 3

Detailed Description

Generator for spider 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.ilChartSpider.php.

Member Function Documentation

ilChartSpider::addCustomJS ( )

protected

Add type-specific JS script.

Reimplemented from ilChart.

Definition at line 70 of file class.ilChartSpider.php.

References $tpl.

        {
                global $tpl;
                
                $tpl->addJavascript("Services/Chart/js/flot/jquery.flot.highlighter.js");
                $tpl->addJavascript("Services/Chart/js/flot/jquery.flot.spider.js");
        }

ilChartSpider::getDataInstance

(

$a_type = null

)

Get data series instance.

Returns

ilChartData

Reimplemented from ilChart.

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

        {               
                include_once "Services/Chart/classes/class.ilChartDataSpider.php";
                return new ilChartDataSpider();                                 
        }

ilChartSpider::getLegLabels

(

)

Get leg labels.

Returns

array leg labels (array of strings)

Definition at line 44 of file class.ilChartSpider.php.

References $leg_labels.

        {
                return $this->leg_labels;
        }

ilChartSpider::getYAxisMax

(

)

Get y axis max value.

Returns

float y axis max value

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

References $y_max.

Referenced by parseGlobalOptions().

        {
                return $this->y_max;
        }

Here is the caller graph for this function:

ilChartSpider::isValidDataType ( ilChartData  $a_series )

protected

Validate data series.

Returns

bool

Reimplemented from ilChart.

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

        {
                return ($a_series instanceof ilChartDataSpider);
        }

ilChartSpider::parseGlobalOptions

(

stdClass

$a_options

)

Convert (global) properties to flot config.

Parameters

object

$a_options

Reimplemented from ilChart.

Definition at line 78 of file class.ilChartSpider.php.

References getYAxisMax(), and ilChart\renderColor().

        {               
                $a_options->grid = new stdClass();
                $a_options->grid->hoverable = false;
                $a_options->grid->clickable = false;
                $a_options->grid->ticks = $this->getYAxisMax();
                $a_options->grid->tickColor = ilChart::renderColor("#000", "0.1");
                $a_options->grid->mode = "spider";
        }

Here is the call graph for this function:

ilChartSpider::setLegLabels

(

$a_val

)

Set leg labels.

Parameters

array

$a_val

leg labels (array of strings)

Definition at line 34 of file class.ilChartSpider.php.

        {
                $this->leg_labels = $a_val;
        }

ilChartSpider::setYAxisMax

(

$a_val

)

Set y axis max value.

Parameters

float

$a_val

y axis max value

Definition at line 55 of file class.ilChartSpider.php.

        {
                $this->y_max = $a_val;
        }

Field Documentation

ilChartSpider::$leg_labels = array()

protected

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

Referenced by getLegLabels().

ilChartSpider::$y_max = 0

protected

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

Referenced by getYAxisMax().

---

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

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