\PHPExcel_Chart_DataSeriesValues

PHPExcel_Chart_DataSeriesValues

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

Summary

Methods
Properties
Constants
__construct()
getDataType()
setDataType()
getDataSource()
setDataSource()
getPointMarker()
setPointMarker()
getFormatCode()
setFormatCode()
getPointCount()
isMultiLevelSeries()
multiLevelCount()
getDataValues()
getDataValue()
setDataValues()
refresh()
No public properties found
DATASERIES_TYPE_STRING
DATASERIES_TYPE_NUMBER
No protected methods found
No protected properties found
N/A
stripNulls()
$dataTypeValues
$dataType
$dataSource
$formatCode
$pointMarker
$pointCount
$dataValues
N/A

Constants

DATASERIES_TYPE_STRING

DATASERIES_TYPE_STRING = 'String'

DATASERIES_TYPE_NUMBER

DATASERIES_TYPE_NUMBER = 'Number'

Properties

$dataTypeValues

$dataTypeValues : 

Type

$dataType

$dataType : string

Series Data Type

Type

string

$dataSource

$dataSource : string

Series Data Source

Type

string

$formatCode

$formatCode : string

Format Code

Type

string

$pointMarker

$pointMarker : string

Series Point Marker

Type

string

$pointCount

$pointCount : integer

Point Count (The number of datapoints in the dataseries)

Type

integer

$dataValues

$dataValues : array

Data Values

Type

array — of mixed

Methods

__construct()

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

Create a new PHPExcel_Chart_DataSeriesValues object

Parameters

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

getDataType()

getDataType() : string

Get Series Data Type

Returns

string

setDataType()

setDataType(string  $dataType = self::DATASERIES_TYPE_NUMBER) : \PHPExcel_Chart_DataSeriesValues

Set Series Data Type

Parameters

string $dataType

Datatype of this data series Typical values are: PHPExcel_Chart_DataSeriesValues::DATASERIES_TYPE_STRING Normally used for axis point values PHPExcel_Chart_DataSeriesValues::DATASERIES_TYPE_NUMBER Normally used for chart data values

Returns

\PHPExcel_Chart_DataSeriesValues

getDataSource()

getDataSource() : string

Get Series Data Source (formula)

Returns

string

setDataSource()

setDataSource(string  $dataSource = null,   $refreshDataValues = true) : \PHPExcel_Chart_DataSeriesValues

Set Series Data Source (formula)

Parameters

string $dataSource
$refreshDataValues

Returns

\PHPExcel_Chart_DataSeriesValues

getPointMarker()

getPointMarker() : string

Get Point Marker

Returns

string

setPointMarker()

setPointMarker(string  $marker = null) : \PHPExcel_Chart_DataSeriesValues

Set Point Marker

Parameters

string $marker

Returns

\PHPExcel_Chart_DataSeriesValues

getFormatCode()

getFormatCode() : string

Get Series Format Code

Returns

string

setFormatCode()

setFormatCode(string  $formatCode = null) : \PHPExcel_Chart_DataSeriesValues

Set Series Format Code

Parameters

string $formatCode

Returns

\PHPExcel_Chart_DataSeriesValues

getPointCount()

getPointCount() : integer

Get Series Point Count

Returns

integer

isMultiLevelSeries()

isMultiLevelSeries() : boolean

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

Returns

boolean

multiLevelCount()

multiLevelCount() : boolean

Return the level count of a multi-level Data Series

Returns

boolean

getDataValues()

getDataValues() : array

Get Series Data Values

Returns

array —

of mixed

getDataValue()

getDataValue() : mixed

Get the first Series Data value

Returns

mixed

setDataValues()

setDataValues(array  $dataValues = array(), boolean  $refreshDataSource = true) : \PHPExcel_Chart_DataSeriesValues

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

Returns

\PHPExcel_Chart_DataSeriesValues

refresh()

refresh(\PHPExcel_Worksheet  $worksheet,   $flatten = true) 

Parameters

\PHPExcel_Worksheet $worksheet
$flatten

stripNulls()

stripNulls(  $var) 

Parameters

$var