ilChartDataPie Class Reference

Chart data pie series. More...

Inheritance diagram for ilChartDataPie:

Collaboration diagram for ilChartDataPie:

Public Member Functions
	setLineWidth ($a_value)
	Set line width. More...
	getLineWidth ()
	Get line width. More...
	setLabelRadius ($a_value)
	Sets the radius at which to place the labels. More...
	getLabelRadius ()
	addPoint ($a_value, $a_caption=null)
	parseData (array &$a_data)
	parseGlobalOptions (stdClass $a_options, ilChart $a_chart)
Public Member Functions inherited from ilChartData
	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 ()
Protected Member Functions inherited from ilChartData
	getTypeString ()
	Get series type. More...
	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...

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

Detailed Description

Chart data pie 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.ilChartDataPie.php.

Member Function Documentation

addPoint()

ilChartDataPie::addPoint	(		$a_value,
			$a_caption = null
	)

Definition at line 64 of file class.ilChartDataPie.php.

        {               
                $this->data[] = array($a_value, $a_caption);            
        }

getLabelRadius()

ilChartDataPie::getLabelRadius

(

)

Returns

mixed

Definition at line 59 of file class.ilChartDataPie.php.

References $label_radius.

Referenced by parseData(), and parseGlobalOptions().

    {
        return $this->label_radius;
    }

Here is the caller graph for this function:

getLineWidth()

ilChartDataPie::getLineWidth

(

)

Get line width.

Returns

int

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

References $line_width.

Referenced by parseGlobalOptions().

        {
                return $this->line_width;
        }

Here is the caller graph for this function:

getTypeString()

ilChartDataPie::getTypeString ( )

protected

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

Referenced by parseData().

        {
                return "pie";
        }

Here is the caller graph for this function:

parseData()

ilChartDataPie::parseData

(

array &

$a_data

)

Definition at line 69 of file class.ilChartDataPie.php.

References $options, getLabelRadius(), getTypeString(), and ilChartData\isHidden().

        {
                foreach($this->data as $slice)
                {
                        $series = new stdClass();
                        $series->label = str_replace("\"", "\\\"", $slice[1]);
                        
                        // add percentage to legend
                        if(!$this->getLabelRadius())
                        {
                                $series->label .= " (".$slice[0]."%)";
                        }
                        
                        $series->data = $slice[0];              

                        $options = array("show"=>($this->isHidden() ? false : true));
                        
                        $series->{$this->getTypeString()} = $options;

                        $a_data[] = $series;
                }
        }

Here is the call graph for this function:

parseGlobalOptions()

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

Definition at line 92 of file class.ilChartDataPie.php.

References ilChartData\$fill, ilChartData\getFill(), getLabelRadius(), getLineWidth(), and ilChart\renderColor().

        {
                $a_options->series->pie = new stdClass();
                $a_options->series->pie->show = true;           
                                
                // fill vs. stroke - trying to normalize data attributes
                
                $fill = $this->getFill();
                $width = $this->getLineWidth();
                if($fill["fill"] || $width)
                {
                        $a_options->series->pie->stroke = new stdClass;                 
                        if($width)
                        {
                                $a_options->series->pie->stroke->width = $width;
                        }                       
                        if($fill["color"])
                        {
                                $a_options->series->pie->stroke->color = ilChart::renderColor($fill["color"], $fill["fill"]);
                        }
                }

                $radius = $this->getLabelRadius();
                if ($radius) 
                {
                        $a_options->series->pie->label = new stdClass;
                        $a_options->series->pie->label->background = new stdClass;
                        $a_options->series->pie->radius = 1;
                        $a_options->series->pie->label->radius = $radius;
                        $a_options->series->pie->label->show = true;
                        $a_options->series->pie->label->background->color = "#444";
                        $a_options->series->pie->label->background->opacity = 0.8;
                }               
        }

Here is the call graph for this function:

setLabelRadius()

ilChartDataPie::setLabelRadius

(

$a_value

)

Sets the radius at which to place the labels.

If value is between 0 and 1 (inclusive) then it will use that as a percentage of the available space (size of the container), otherwise it will use the value as a direct pixel length.

Parameters

mixed

$a_value

Definition at line 51 of file class.ilChartDataPie.php.

    {
        $this->label_radius = $a_value;
    }

setLineWidth()

ilChartDataPie::setLineWidth

(

$a_value

)

Set line width.

Parameters

int

$a_value

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

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

Field Documentation

$label_radius

ilChartDataPie::$label_radius

protected

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

Referenced by getLabelRadius().

$line_width

ilChartDataPie::$line_width

protected

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

Referenced by getLineWidth().

---

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

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