ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
ilChartGrid Class Reference

Generator for grid-based charts. More...

+ Inheritance diagram for ilChartGrid:
+ Collaboration diagram for ilChartGrid:

Public Member Functions

 getDataInstance ($a_type=null)
 
 setTicks ($a_x, $a_y, $a_labeled=false)
 Set ticks. More...
 
 getTicks ()
 Get ticks. More...
 
 setYAxisToInteger ($a_status)
 Restrict y-axis to integer values. More...
 
 setXAxisToInteger ($a_status)
 Restrict x-axis to integer values. More...
 
 parseGlobalOptions (stdClass $a_options)
 
- Public Member Functions inherited from ilChart
 getDataInstance ($a_type=null)
 Get data series instance. More...
 
 setSize ($a_x, $a_y)
 Set chart size. More...
 
 addData (ilChartData $a_series, $a_idx=null)
 Add data series. More...
 
 setLegend (ilChartLegend $a_legend)
 Set chart legend. More...
 
 setColors ($a_values)
 Set colors. More...
 
 getColors ()
 Get colors. More...
 
 setShadow ($a_value)
 Set shadow. More...
 
 getShadow ()
 Get shadow. More...
 
 setAutoResize ($a_value)
 Toggle auto-resizing on window resize/redraw. More...
 
 setStacked ($a_value)
 Toggle stacking. More...
 
 parseGlobalOptions (stdClass $a_options)
 Convert (global) properties to flot config. More...
 
 getHTML ()
 Render. More...
 

Data Fields

const DATA_LINES = 1
 
const DATA_BARS = 2
 
const DATA_POINTS = 3
 
- Data Fields inherited from ilChart
const TYPE_GRID = 1
 
const TYPE_PIE = 2
 
const TYPE_SPIDER = 3
 

Protected Member Functions

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

Protected Attributes

 $ticks
 
 $integer_axis
 
- Protected Attributes inherited from ilChart
 $id
 
 $width
 
 $height
 
 $data
 
 $legend
 
 $shadow
 
 $colors
 
 $auto_resize
 
 $stacked
 

Additional Inherited Members

- Static Public Member Functions inherited from ilChart
static getInstanceByType ($a_type, $a_id)
 Get type instance. More...
 
static isValidColor ($a_value)
 Validate html color code. More...
 
static renderColor ($a_value, $a_opacity=1)
 Render html color code. More...
 

Detailed Description

Generator for grid-based 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.ilChartGrid.php.

Constructor & Destructor Documentation

◆ __construct()

ilChartGrid::__construct (   $a_id)
protected

Definition at line 22 of file class.ilChartGrid.php.

References setXAxisToInteger(), and setYAxisToInteger().

23  {
24  parent::__construct($a_id);
25 
26  $this->setXAxisToInteger(false);
27  $this->setYAxisToInteger(false);
28  }
setXAxisToInteger($a_status)
Restrict x-axis to integer values.
setYAxisToInteger($a_status)
Restrict y-axis to integer values.
+ Here is the call graph for this function:

Member Function Documentation

◆ getDataInstance()

ilChartGrid::getDataInstance (   $a_type = null)

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

References $a_type.

31  {
32  switch($a_type)
33  {
34  case self::DATA_BARS:
35  include_once "Services/Chart/classes/class.ilChartDataBars.php";
36  return new ilChartDataBars();
37 
38  case self::DATA_POINTS:
39  include_once "Services/Chart/classes/class.ilChartDataPoints.php";
40  return new ilChartDataPoints();
41 
42  default:
43  case self::DATA_LINES:
44  include_once "Services/Chart/classes/class.ilChartDataLines.php";
45  return new ilChartDataLines();
46  }
47  }
Chart data points series.
$a_type
Definition: workflow.php:93
Chart data bars series.
Chart data lines series.

◆ getTicks()

ilChartGrid::getTicks ( )

Get ticks.

Returns
array (x, y)

Definition at line 77 of file class.ilChartGrid.php.

References $ticks.

Referenced by parseGlobalOptions().

78  {
79  return $this->ticks;
80  }
+ Here is the caller graph for this function:

◆ isValidDataType()

ilChartGrid::isValidDataType ( ilChartData  $a_series)
protected

Definition at line 49 of file class.ilChartGrid.php.

50  {
51  if($a_series instanceof ilChartDataLines
52  || $a_series instanceof ilChartDataBars
53  || $a_series instanceof ilChartDataPoints)
54  {
55  return true;
56  }
57  return false;
58  }
Chart data points series.
Chart data bars series.
Chart data lines series.

◆ parseGlobalOptions()

ilChartGrid::parseGlobalOptions ( stdClass  $a_options)

Definition at line 102 of file class.ilChartGrid.php.

References $ticks, array, and getTicks().

103  {
104  // axis/ticks
105  $tmp = array();
106  $ticks = $this->getTicks();
107  if($ticks)
108  {
109  $labeled = (bool)$ticks["labeled"];
110  unset($ticks["labeled"]);
111  foreach($ticks as $axis => $def)
112  {
113  if(is_numeric($def) || is_array($def))
114  {
115  $a_options->{$axis."axis"} = new stdClass();
116  }
117  if(is_numeric($def))
118  {
119  $a_options->{$axis."axis"}->ticks = $def;
120  }
121  else if(is_array($def))
122  {
123  $a_options->{$axis."axis"}->ticks = array();
124  foreach($def as $idx => $value)
125  {
126  if($labeled)
127  {
128  $a_options->{$axis."axis"}->ticks[] = array($idx, $value);
129  }
130  else
131  {
132  $a_options->{$axis."axis"}->ticks[] = $value;
133  }
134  }
135  }
136  }
137  }
138 
139  // optional: remove decimals
140  if($this->integer_axis["x"] && !isset($a_options->xaxis))
141  {
142  $a_options->{"xaxis"} = new stdClass();
143  $a_options->{"xaxis"}->tickDecimals = 0;
144  }
145  if($this->integer_axis["y"] && !isset($a_options->yaxis))
146  {
147  $a_options->{"yaxis"} = new stdClass();
148  $a_options->{"yaxis"}->tickDecimals = 0;
149  }
150  }
getTicks()
Get ticks.
Create styles array
The data for the language used.
+ Here is the call graph for this function:

◆ setTicks()

ilChartGrid::setTicks (   $a_x,
  $a_y,
  $a_labeled = false 
)

Set ticks.

Parameters
int | array$a_x
int | array$a_y
bool$a_labeled

Definition at line 67 of file class.ilChartGrid.php.

References array.

68  {
69  $this->ticks = array("x" => $a_x, "y" => $a_y, "labeled" => (bool)$a_labeled);
70  }
Create styles array
The data for the language used.

◆ setXAxisToInteger()

ilChartGrid::setXAxisToInteger (   $a_status)

Restrict x-axis to integer values.

Parameters
bool$a_status

Definition at line 97 of file class.ilChartGrid.php.

Referenced by __construct().

98  {
99  $this->integer_axis["x"] = (bool)$a_status;
100  }
+ Here is the caller graph for this function:

◆ setYAxisToInteger()

ilChartGrid::setYAxisToInteger (   $a_status)

Restrict y-axis to integer values.

Parameters
bool$a_status

Definition at line 87 of file class.ilChartGrid.php.

Referenced by __construct().

88  {
89  $this->integer_axis["y"] = (bool)$a_status;
90  }
+ Here is the caller graph for this function:

Field Documentation

◆ $integer_axis

ilChartGrid::$integer_axis
protected

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

◆ $ticks

ilChartGrid::$ticks
protected

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

Referenced by getTicks(), and parseGlobalOptions().

◆ DATA_BARS

◆ DATA_LINES

◆ DATA_POINTS

const ilChartGrid::DATA_POINTS = 3

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


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