class PHPExcel_Chart_DataSeriesValues

PHPExcelChartDataSeriesValues

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Constants

DATASERIES_TYPE_STRING

DATASERIES_TYPE_NUMBER

Methods

__construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount, $dataValues = array(), $marker = null)

Create a new PHPExcelChartDataSeriesValues object

string
getDataType()

Get Series Data Type

setDataType(string $dataType = self::DATASERIES_TYPE_NUMBER)

Set Series Data Type

string
getDataSource()

Get Series Data Source (formula)

setDataSource($dataSource = null, $refreshDataValues = true)

Set Series Data Source (formula)

string
getPointMarker()

Get Point Marker

setPointMarker(string $marker = null)

Set Point Marker

string
getFormatCode()

Get Series Format Code

setFormatCode(string $formatCode = null)

Set Series Format Code

integer
getPointCount()

Get Series Point Count

boolean
isMultiLevelSeries()

Identify if the Data Series is a multi-level or a simple series

boolean
multiLevelCount()

Return the level count of a multi-level Data Series

array
getDataValues()

Get Series Data Values

mixed
getDataValue()

Get the first Series Data value

setDataValues(array $dataValues = array(), boolean $refreshDataSource = true)

Set Series Data Values

refresh(PHPExcel_Worksheet $worksheet, $flatten = true)

No description

Details

at line 93
__construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount, $dataValues = array(), $marker = null)

Create a new PHPExcelChartDataSeriesValues object

Parameters

$dataType
$dataSource
$formatCode
$pointCount
$dataValues
$marker

at line 108
string getDataType()

Get Series Data Type

Return Value

string

at line 124
PHPExcel_Chart_DataSeriesValues setDataType(string $dataType = self::DATASERIES_TYPE_NUMBER)

Set Series Data Type

Parameters

string $dataType Datatype of this data series Typical values are: PHPExcelChartDataSeriesValues::DATASERIESTYPESTRING Normally used for axis point values PHPExcelChartDataSeriesValues::DATASERIESTYPENUMBER Normally used for chart data values

Return Value

PHPExcel_Chart_DataSeriesValues

at line 139
string getDataSource()

Get Series Data Source (formula)

Return Value

string

at line 150
PHPExcel_Chart_DataSeriesValues setDataSource($dataSource = null, $refreshDataValues = true)

Set Series Data Source (formula)

Parameters

$dataSource
$refreshDataValues

Return Value

PHPExcel_Chart_DataSeriesValues

at line 166
string getPointMarker()

Get Point Marker

Return Value

string

at line 177
PHPExcel_Chart_DataSeriesValues setPointMarker(string $marker = null)

Set Point Marker

Parameters

string $marker

Return Value

PHPExcel_Chart_DataSeriesValues

at line 189
string getFormatCode()

Get Series Format Code

Return Value

string

at line 200
PHPExcel_Chart_DataSeriesValues setFormatCode(string $formatCode = null)

Set Series Format Code

Parameters

string $formatCode

Return Value

PHPExcel_Chart_DataSeriesValues

at line 212
integer getPointCount()

Get Series Point Count

Return Value

integer

at line 222
boolean isMultiLevelSeries()

Identify if the Data Series is a multi-level or a simple series

Return Value

boolean

at line 235
boolean multiLevelCount()

Return the level count of a multi-level Data Series

Return Value

boolean

at line 249
array getDataValues()

Get Series Data Values

Return Value

array of mixed

at line 259
mixed getDataValue()

Get the first Series Data value

Return Value

mixed

at line 279
PHPExcel_Chart_DataSeriesValues setDataValues(array $dataValues = array(), boolean $refreshDataSource = true)

Set Series Data Values

Parameters

array $dataValues
boolean $refreshDataSource TRUE - refresh the value of dataSource based on the values of $dataValues FALSE - don't change the value of dataSource

Return Value

PHPExcel_Chart_DataSeriesValues

at line 296
refresh(PHPExcel_Worksheet $worksheet, $flatten = true)

Parameters

PHPExcel_Worksheet $worksheet
$flatten