ilChartDataBars Class Reference

Chart data bars series. More...

Inheritance diagram for ilChartDataBars:

Collaboration diagram for ilChartDataBars:

Public Member Functions
	setLineWidth ($a_value)
	Set line width. More...
	getLineWidth ()
	Get line width. More...
	setBarOptions ($a_width, $a_align="center", $a_horizontal=false)
	Set bar options. More...
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 ()
	Get series type. More...
	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...
	getTypeString ()
	Get series type. More...
	parseDataOptions (array &$a_options)
	Convert data options to flot config. More...

Protected Attributes
	$line_width
	$bar_width
	$bar_align
	$bar_horizontal
Protected Attributes inherited from ilChartData
	$type
	$label
	$data
	$fill
	$fill_color
	$hidden

Detailed Description

Chart data bars 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.ilChartDataBars.php.

Member Function Documentation

getLineWidth()

ilChartDataBars::getLineWidth

(

)

Get line width.

Returns

int

Definition at line 40 of file class.ilChartDataBars.php.

    {
        return $this->line_width;
    }

References $line_width.

Referenced by parseDataOptions().

Here is the caller graph for this function:

getTypeString()

ilChartDataBars::getTypeString ( )

protected

Get series type.

Returns

string

Reimplemented from ilChartData.

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

    {
        return "bars";
    }

parseDataOptions()

ilChartDataBars::parseDataOptions ( array &  $a_options )

protected

Convert data options to flot config.

Parameters

array	$a_options
ilChart	$a_chart

Reimplemented from ilChartData.

Definition at line 61 of file class.ilChartDataBars.php.

    {
        $width = $this->getLineWidth();
        if ($width !== null) {
            $a_options["lineWidth"] = $width;
        }
        
        if ($this->bar_width) {
            $a_options["barWidth"] = $this->bar_width;
            $a_options["align"] = $this->bar_align;
            if ($this->bar_horizontal) {
                $a_options["horizontal"] = true;
            }
        }
    }

References $bar_align, $bar_width, and getLineWidth().

Here is the call graph for this function:

setBarOptions()

ilChartDataBars::setBarOptions	(		$a_width,
			$a_align = "center",
			$a_horizontal = false
	)

Set bar options.

Parameters

float	$a_width
string	$a_align
bool	$a_horizontal

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

    {
        $this->bar_width = (float) str_replace(",", ".", $a_width);
        if (in_array((string) $a_align, array("center", "left"))) {
            $this->bar_align = (string) $a_align;
        }
        $this->bar_horizontal = (bool) $a_horizontal;
    }

setLineWidth()

ilChartDataBars::setLineWidth

(

$a_value

)

Set line width.

Parameters

int

$a_value

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

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

Field Documentation

$bar_align

ilChartDataBars::$bar_align

protected

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

Referenced by parseDataOptions().

$bar_horizontal

ilChartDataBars::$bar_horizontal

protected

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

$bar_width

ilChartDataBars::$bar_width

protected

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

Referenced by parseDataOptions().

$line_width

ilChartDataBars::$line_width

protected

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

Referenced by getLineWidth().

---

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

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