ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
PHPExcel_Chart_DataSeries Class Reference
+ Collaboration diagram for PHPExcel_Chart_DataSeries:

Public Member Functions

 __construct ($plotType=null, $plotGrouping=null, $plotOrder=array(), $plotLabel=array(), $plotCategory=array(), $plotValues=array(), $plotDirection=null, $smoothLine=null, $plotStyle=null)
 Create a new PHPExcel_Chart_DataSeries. More...
 
 getPlotType ()
 Get Plot Type. More...
 
 setPlotType ($plotType='')
 
 getPlotGrouping ()
 Get Plot Grouping Type. More...
 
 setPlotGrouping ($groupingType=null)
 
 getPlotDirection ()
 Get Plot Direction. More...
 
 setPlotDirection ($plotDirection=null)
 
 getPlotOrder ()
 Get Plot Order. More...
 
 getPlotLabels ()
 Get Plot Labels. More...
 
 getPlotLabelByIndex ($index)
 Get Plot Label by Index. More...
 
 getPlotCategories ()
 Get Plot Categories. More...
 
 getPlotCategoryByIndex ($index)
 Get Plot Category by Index. More...
 
 getPlotStyle ()
 Get Plot Style. More...
 
 setPlotStyle ($plotStyle=null)
 
 getPlotValues ()
 Get Plot Values. More...
 
 getPlotValuesByIndex ($index)
 Get Plot Values by Index. More...
 
 getPlotSeriesCount ()
 Get Number of Plot Series. More...
 
 getSmoothLine ()
 Get Smooth Line. More...
 
 setSmoothLine ($smoothLine=TRUE)
 
 refresh (PHPExcel_Worksheet $worksheet)
 

Data Fields

const TYPE_BARCHART = 'barChart'
 
const TYPE_BARCHART_3D = 'bar3DChart'
 
const TYPE_LINECHART = 'lineChart'
 
const TYPE_LINECHART_3D = 'line3DChart'
 
const TYPE_AREACHART = 'areaChart'
 
const TYPE_AREACHART_3D = 'area3DChart'
 
const TYPE_PIECHART = 'pieChart'
 
const TYPE_PIECHART_3D = 'pie3DChart'
 
const TYPE_DOUGHTNUTCHART = 'doughnutChart'
 
const TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART
 
const TYPE_SCATTERCHART = 'scatterChart'
 
const TYPE_SURFACECHART = 'surfaceChart'
 
const TYPE_SURFACECHART_3D = 'surface3DChart'
 
const TYPE_RADARCHART = 'radarChart'
 
const TYPE_BUBBLECHART = 'bubbleChart'
 
const TYPE_STOCKCHART = 'stockChart'
 
const TYPE_CANDLECHART = self::TYPE_STOCKCHART
 
const GROUPING_CLUSTERED = 'clustered'
 
const GROUPING_STACKED = 'stacked'
 
const GROUPING_PERCENT_STACKED = 'percentStacked'
 
const GROUPING_STANDARD = 'standard'
 
const DIRECTION_BAR = 'bar'
 
const DIRECTION_HORIZONTAL = self::DIRECTION_BAR
 
const DIRECTION_COL = 'col'
 
const DIRECTION_COLUMN = self::DIRECTION_COL
 
const DIRECTION_VERTICAL = self::DIRECTION_COL
 
const STYLE_LINEMARKER = 'lineMarker'
 
const STYLE_SMOOTHMARKER = 'smoothMarker'
 
const STYLE_MARKER = 'marker'
 
const STYLE_FILLED = 'filled'
 

Private Attributes

 $_plotType = null
 
 $_plotGrouping = null
 
 $_plotDirection = null
 
 $_plotStyle = null
 
 $_plotOrder = array()
 
 $_plotLabel = array()
 
 $_plotCategory = array()
 
 $_smoothLine = null
 
 $_plotValues = array()
 

Detailed Description

Definition at line 36 of file DataSeries.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Chart_DataSeries::__construct (   $plotType = null,
  $plotGrouping = null,
  $plotOrder = array(),
  $plotLabel = array(),
  $plotCategory = array(),
  $plotValues = array(),
  $plotDirection = null,
  $smoothLine = null,
  $plotStyle = null 
)

Create a new PHPExcel_Chart_DataSeries.

Definition at line 140 of file DataSeries.php.

141 {
142 $this->_plotType = $plotType;
143 $this->_plotGrouping = $plotGrouping;
144 $this->_plotOrder = $plotOrder;
145 $keys = array_keys($plotValues);
146 $this->_plotValues = $plotValues;
147 if ((count($plotLabel) == 0) || (is_null($plotLabel[$keys[0]]))) {
148 $plotLabel[$keys[0]] = new PHPExcel_Chart_DataSeriesValues();
149 }
150
151 $this->_plotLabel = $plotLabel;
152 if ((count($plotCategory) == 0) || (is_null($plotCategory[$keys[0]]))) {
153 $plotCategory[$keys[0]] = new PHPExcel_Chart_DataSeriesValues();
154 }
155 $this->_plotCategory = $plotCategory;
156 $this->_smoothLine = $smoothLine;
157 $this->_plotStyle = $plotStyle;
158
159 if (is_null($plotDirection)) {
160 $plotDirection = self::DIRECTION_COL;
161 }
162 $this->_plotDirection = $plotDirection;
163 }

References DIRECTION_COL.

Member Function Documentation

◆ getPlotCategories()

PHPExcel_Chart_DataSeries::getPlotCategories ( )

Get Plot Categories.

Returns
array of PHPExcel_Chart_DataSeriesValues

Definition at line 263 of file DataSeries.php.

263 {
265 }

References $_plotCategory.

◆ getPlotCategoryByIndex()

PHPExcel_Chart_DataSeries::getPlotCategoryByIndex (   $index)

Get Plot Category by Index.

Returns
PHPExcel_Chart_DataSeriesValues

Definition at line 272 of file DataSeries.php.

272 {
273 $keys = array_keys($this->_plotCategory);
274 if (in_array($index,$keys)) {
275 return $this->_plotCategory[$index];
276 } elseif(isset($keys[$index])) {
277 return $this->_plotCategory[$keys[$index]];
278 }
279 return false;
280 }

◆ getPlotDirection()

PHPExcel_Chart_DataSeries::getPlotDirection ( )

Get Plot Direction.

Returns
string

Definition at line 210 of file DataSeries.php.

210 {
212 }

References $_plotDirection.

◆ getPlotGrouping()

PHPExcel_Chart_DataSeries::getPlotGrouping ( )

Get Plot Grouping Type.

Returns
string

Definition at line 190 of file DataSeries.php.

190 {
192 }

References $_plotGrouping.

◆ getPlotLabelByIndex()

PHPExcel_Chart_DataSeries::getPlotLabelByIndex (   $index)

Get Plot Label by Index.

Returns
PHPExcel_Chart_DataSeriesValues

Definition at line 248 of file DataSeries.php.

248 {
249 $keys = array_keys($this->_plotLabel);
250 if (in_array($index,$keys)) {
251 return $this->_plotLabel[$index];
252 } elseif(isset($keys[$index])) {
253 return $this->_plotLabel[$keys[$index]];
254 }
255 return false;
256 }

◆ getPlotLabels()

PHPExcel_Chart_DataSeries::getPlotLabels ( )

Get Plot Labels.

Returns
array of PHPExcel_Chart_DataSeriesValues

Definition at line 239 of file DataSeries.php.

239 {
240 return $this->_plotLabel;
241 }

References $_plotLabel.

◆ getPlotOrder()

PHPExcel_Chart_DataSeries::getPlotOrder ( )

Get Plot Order.

Returns
string

Definition at line 230 of file DataSeries.php.

230 {
231 return $this->_plotOrder;
232 }

References $_plotOrder.

◆ getPlotSeriesCount()

PHPExcel_Chart_DataSeries::getPlotSeriesCount ( )

Get Number of Plot Series.

Returns
integer

Definition at line 331 of file DataSeries.php.

331 {
332 return count($this->_plotValues);
333 }

◆ getPlotStyle()

PHPExcel_Chart_DataSeries::getPlotStyle ( )

Get Plot Style.

Returns
string

Definition at line 287 of file DataSeries.php.

287 {
288 return $this->_plotStyle;
289 }

References $_plotStyle.

◆ getPlotType()

PHPExcel_Chart_DataSeries::getPlotType ( )

Get Plot Type.

Returns
string

Definition at line 170 of file DataSeries.php.

170 {
171 return $this->_plotType;
172 }

References $_plotType.

◆ getPlotValues()

PHPExcel_Chart_DataSeries::getPlotValues ( )

Get Plot Values.

Returns
array of PHPExcel_Chart_DataSeriesValues

Definition at line 307 of file DataSeries.php.

307 {
308 return $this->_plotValues;
309 }

References $_plotValues.

◆ getPlotValuesByIndex()

PHPExcel_Chart_DataSeries::getPlotValuesByIndex (   $index)

Get Plot Values by Index.

Returns
PHPExcel_Chart_DataSeriesValues

Definition at line 316 of file DataSeries.php.

316 {
317 $keys = array_keys($this->_plotValues);
318 if (in_array($index,$keys)) {
319 return $this->_plotValues[$index];
320 } elseif(isset($keys[$index])) {
321 return $this->_plotValues[$keys[$index]];
322 }
323 return false;
324 }

◆ getSmoothLine()

PHPExcel_Chart_DataSeries::getSmoothLine ( )

Get Smooth Line.

Returns
boolean

Definition at line 340 of file DataSeries.php.

340 {
341 return $this->_smoothLine;
342 }

References $_smoothLine.

◆ refresh()

PHPExcel_Chart_DataSeries::refresh ( PHPExcel_Worksheet  $worksheet)

Definition at line 355 of file DataSeries.php.

355 {
356 foreach($this->_plotValues as $plotValues) {
357 if ($plotValues !== NULL)
358 $plotValues->refresh($worksheet, TRUE);
359 }
360 foreach($this->_plotLabel as $plotValues) {
361 if ($plotValues !== NULL)
362 $plotValues->refresh($worksheet, TRUE);
363 }
364 foreach($this->_plotCategory as $plotValues) {
365 if ($plotValues !== NULL)
366 $plotValues->refresh($worksheet, FALSE);
367 }
368 }
$worksheet

References $worksheet.

◆ setPlotDirection()

PHPExcel_Chart_DataSeries::setPlotDirection (   $plotDirection = null)
Set Plot Direction

@param string $plotDirection
Returns
PHPExcel_Chart_DataSeries

Definition at line 220 of file DataSeries.php.

220 {
221 $this->_plotDirection = $plotDirection;
222 return $this;
223 }

◆ setPlotGrouping()

PHPExcel_Chart_DataSeries::setPlotGrouping (   $groupingType = null)
Set Plot Grouping Type

@param string $groupingType
Returns
PHPExcel_Chart_DataSeries

Definition at line 200 of file DataSeries.php.

200 {
201 $this->_plotGrouping = $groupingType;
202 return $this;
203 }

◆ setPlotStyle()

PHPExcel_Chart_DataSeries::setPlotStyle (   $plotStyle = null)
Set Plot Style

@param string $plotStyle
Returns
PHPExcel_Chart_DataSeries

Definition at line 297 of file DataSeries.php.

297 {
298 $this->_plotStyle = $plotStyle;
299 return $this;
300 }

◆ setPlotType()

PHPExcel_Chart_DataSeries::setPlotType (   $plotType = '')
Set Plot Type

@param string $plotType
Returns
PHPExcel_Chart_DataSeries

Definition at line 180 of file DataSeries.php.

180 {
181 $this->_plotType = $plotType;
182 return $this;
183 }

◆ setSmoothLine()

PHPExcel_Chart_DataSeries::setSmoothLine (   $smoothLine = TRUE)
Set Smooth Line

@param boolean $smoothLine
Returns
PHPExcel_Chart_DataSeries

Definition at line 350 of file DataSeries.php.

350 {
351 $this->_smoothLine = $smoothLine;
352 return $this;
353 }

Field Documentation

◆ $_plotCategory

PHPExcel_Chart_DataSeries::$_plotCategory = array()
private

Definition at line 121 of file DataSeries.php.

Referenced by getPlotCategories().

◆ $_plotDirection

PHPExcel_Chart_DataSeries::$_plotDirection = null
private

Definition at line 93 of file DataSeries.php.

Referenced by getPlotDirection().

◆ $_plotGrouping

PHPExcel_Chart_DataSeries::$_plotGrouping = null
private

Definition at line 86 of file DataSeries.php.

Referenced by getPlotGrouping().

◆ $_plotLabel

PHPExcel_Chart_DataSeries::$_plotLabel = array()
private

Definition at line 114 of file DataSeries.php.

Referenced by getPlotLabels().

◆ $_plotOrder

PHPExcel_Chart_DataSeries::$_plotOrder = array()
private

Definition at line 107 of file DataSeries.php.

Referenced by getPlotOrder().

◆ $_plotStyle

PHPExcel_Chart_DataSeries::$_plotStyle = null
private

Definition at line 100 of file DataSeries.php.

Referenced by getPlotStyle().

◆ $_plotType

PHPExcel_Chart_DataSeries::$_plotType = null
private

Definition at line 79 of file DataSeries.php.

Referenced by getPlotType().

◆ $_plotValues

PHPExcel_Chart_DataSeries::$_plotValues = array()
private

Definition at line 135 of file DataSeries.php.

Referenced by getPlotValues().

◆ $_smoothLine

PHPExcel_Chart_DataSeries::$_smoothLine = null
private

Definition at line 128 of file DataSeries.php.

Referenced by getSmoothLine().

◆ DIRECTION_BAR

const PHPExcel_Chart_DataSeries::DIRECTION_BAR = 'bar'

Definition at line 62 of file DataSeries.php.

◆ DIRECTION_COL

const PHPExcel_Chart_DataSeries::DIRECTION_COL = 'col'

Definition at line 64 of file DataSeries.php.

Referenced by __construct().

◆ DIRECTION_COLUMN

const PHPExcel_Chart_DataSeries::DIRECTION_COLUMN = self::DIRECTION_COL

Definition at line 65 of file DataSeries.php.

◆ DIRECTION_HORIZONTAL

const PHPExcel_Chart_DataSeries::DIRECTION_HORIZONTAL = self::DIRECTION_BAR

Definition at line 63 of file DataSeries.php.

◆ DIRECTION_VERTICAL

const PHPExcel_Chart_DataSeries::DIRECTION_VERTICAL = self::DIRECTION_COL

Definition at line 66 of file DataSeries.php.

◆ GROUPING_CLUSTERED

const PHPExcel_Chart_DataSeries::GROUPING_CLUSTERED = 'clustered'

Definition at line 57 of file DataSeries.php.

◆ GROUPING_PERCENT_STACKED

const PHPExcel_Chart_DataSeries::GROUPING_PERCENT_STACKED = 'percentStacked'

Definition at line 59 of file DataSeries.php.

◆ GROUPING_STACKED

const PHPExcel_Chart_DataSeries::GROUPING_STACKED = 'stacked'

Definition at line 58 of file DataSeries.php.

◆ GROUPING_STANDARD

const PHPExcel_Chart_DataSeries::GROUPING_STANDARD = 'standard'

Definition at line 60 of file DataSeries.php.

◆ STYLE_FILLED

const PHPExcel_Chart_DataSeries::STYLE_FILLED = 'filled'

Definition at line 71 of file DataSeries.php.

◆ STYLE_LINEMARKER

const PHPExcel_Chart_DataSeries::STYLE_LINEMARKER = 'lineMarker'

Definition at line 68 of file DataSeries.php.

◆ STYLE_MARKER

const PHPExcel_Chart_DataSeries::STYLE_MARKER = 'marker'

Definition at line 70 of file DataSeries.php.

◆ STYLE_SMOOTHMARKER

const PHPExcel_Chart_DataSeries::STYLE_SMOOTHMARKER = 'smoothMarker'

Definition at line 69 of file DataSeries.php.

◆ TYPE_AREACHART

const PHPExcel_Chart_DataSeries::TYPE_AREACHART = 'areaChart'

Definition at line 43 of file DataSeries.php.

◆ TYPE_AREACHART_3D

const PHPExcel_Chart_DataSeries::TYPE_AREACHART_3D = 'area3DChart'

Definition at line 44 of file DataSeries.php.

◆ TYPE_BARCHART

const PHPExcel_Chart_DataSeries::TYPE_BARCHART = 'barChart'

◆ TYPE_BARCHART_3D

const PHPExcel_Chart_DataSeries::TYPE_BARCHART_3D = 'bar3DChart'

◆ TYPE_BUBBLECHART

const PHPExcel_Chart_DataSeries::TYPE_BUBBLECHART = 'bubbleChart'

◆ TYPE_CANDLECHART

const PHPExcel_Chart_DataSeries::TYPE_CANDLECHART = self::TYPE_STOCKCHART

Definition at line 55 of file DataSeries.php.

◆ TYPE_DONUTCHART

const PHPExcel_Chart_DataSeries::TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART

◆ TYPE_DOUGHTNUTCHART

const PHPExcel_Chart_DataSeries::TYPE_DOUGHTNUTCHART = 'doughnutChart'

Definition at line 47 of file DataSeries.php.

◆ TYPE_LINECHART

const PHPExcel_Chart_DataSeries::TYPE_LINECHART = 'lineChart'

◆ TYPE_LINECHART_3D

const PHPExcel_Chart_DataSeries::TYPE_LINECHART_3D = 'line3DChart'

Definition at line 42 of file DataSeries.php.

◆ TYPE_PIECHART

const PHPExcel_Chart_DataSeries::TYPE_PIECHART = 'pieChart'

◆ TYPE_PIECHART_3D

const PHPExcel_Chart_DataSeries::TYPE_PIECHART_3D = 'pie3DChart'

◆ TYPE_RADARCHART

const PHPExcel_Chart_DataSeries::TYPE_RADARCHART = 'radarChart'

◆ TYPE_SCATTERCHART

const PHPExcel_Chart_DataSeries::TYPE_SCATTERCHART = 'scatterChart'

◆ TYPE_STOCKCHART

const PHPExcel_Chart_DataSeries::TYPE_STOCKCHART = 'stockChart'

◆ TYPE_SURFACECHART

const PHPExcel_Chart_DataSeries::TYPE_SURFACECHART = 'surfaceChart'

Definition at line 50 of file DataSeries.php.

◆ TYPE_SURFACECHART_3D

const PHPExcel_Chart_DataSeries::TYPE_SURFACECHART_3D = 'surface3DChart'

Definition at line 51 of file DataSeries.php.


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