ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
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. More...
 
 getLineWidth ()
 Get line width. More...
 
 setPointRadius ($a_value)
 Set radius. More...
 
 getPointRadius ()
 Get radius. 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 ()
 
 parseDataOptions (array &$a_options)
 
- 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
 
 $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

◆ getLineWidth()

ilChartDataPoints::getLineWidth ( )

Get line width.

Returns
int

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

References $line_width.

Referenced by parseDataOptions().

39  {
40  return $this->line_width;
41  }
+ Here is the caller graph for this function:

◆ getPointRadius()

ilChartDataPoints::getPointRadius ( )

Get radius.

Returns
int

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

References $radius.

Referenced by parseDataOptions().

59  {
60  return $this->radius;
61  }
+ Here is the caller graph for this function:

◆ getTypeString()

ilChartDataPoints::getTypeString ( )
protected

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

19  {
20  return "points";
21  }

◆ parseDataOptions()

ilChartDataPoints::parseDataOptions ( array $a_options)
protected

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

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

64  {
65  $width = $this->getLineWidth();
66  if ($width !== null) {
67  $a_options["lineWidth"] = $width;
68  }
69 
70  $radius = $this->getPointRadius();
71  if ($radius !== null) {
72  $a_options["radius"] = $radius;
73  }
74  }
getLineWidth()
Get line width.
+ Here is the call graph for this function:

◆ setLineWidth()

ilChartDataPoints::setLineWidth (   $a_value)

Set line width.

Parameters
int$a_value

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

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

◆ setPointRadius()

ilChartDataPoints::setPointRadius (   $a_value)

Set radius.

Parameters
int$a_value

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

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

Field Documentation

◆ $line_width

ilChartDataPoints::$line_width
protected

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

Referenced by getLineWidth().

◆ $radius

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: