Collaboration diagram for PHPExcel_Chart_DataSeriesValues:

Public Member Functions
	__construct ($dataType=self::DATASERIES_TYPE_NUMBER, $dataSource=null, $formatCode=null, $pointCount=0, $dataValues=array(), $marker=null)
	Create a new PHPExcel_Chart_DataSeriesValues object. More...

	getDataType ()
	Get Series Data Type. More...

	setDataType ($dataType=self::DATASERIES_TYPE_NUMBER)
	Set Series Data Type. More...

	getDataSource ()
	Get Series Data Source (formula) More...

	setDataSource ($dataSource=null, $refreshDataValues=true)
	Set Series Data Source (formula) More...

	getPointMarker ()
	Get Point Marker. More...

	setPointMarker ($marker=null)
	Set Point Marker. More...

	getFormatCode ()
	Get Series Format Code. More...

	setFormatCode ($formatCode=null)
	Set Series Format Code. More...

	getPointCount ()
	Get Series Point Count. More...

	isMultiLevelSeries ()
	Identify if the Data Series is a multi-level or a simple series. More...

	multiLevelCount ()
	Return the level count of a multi-level Data Series. More...

	getDataValues ()
	Get Series Data Values. More...

	getDataValue ()
	Get the first Series Data value. More...

	setDataValues ($dataValues=array(), $refreshDataSource=TRUE)
	Set Series Data Values. More...

	refresh (PHPExcel_Worksheet $worksheet, $flatten=TRUE)

Data Fields
const	DATASERIES_TYPE_STRING = 'String'

const	DATASERIES_TYPE_NUMBER = 'Number'

Private Member Functions
	_stripNulls ($var)

Private Attributes
	$_dataType = null

	$_dataSource = null

	$_formatCode = null

	$_marker = null

	$_pointCount = 0

	$_dataValues = array()

Static Private Attributes
static	$_dataTypeValues

Detailed Description

Definition at line 36 of file DataSeriesValues.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new PHPExcel_Chart_DataSeriesValues object.

Definition at line 92 of file DataSeriesValues.php.

        {
                $this->setDataType($dataType);
                $this->_dataSource = $dataSource;
                $this->_formatCode = $formatCode;
                $this->_pointCount = $pointCount;
                $this->_dataValues = $dataValues;
                $this->_marker = $marker;
        }

References setDataType().

Here is the call graph for this function:

Member Function Documentation

◆ _stripNulls()

PHPExcel_Chart_DataSeriesValues::_stripNulls ( $var )

private

Definition at line 276 of file DataSeriesValues.php.

                                           {
                return $var !== NULL;
        }

◆ getDataSource()

PHPExcel_Chart_DataSeriesValues::getDataSource ( )

Get Series Data Source (formula)

Returns: string

Definition at line 136 of file DataSeriesValues.php.

                                        {
                return $this->_dataSource;
        }

References $_dataSource.

◆ getDataType()

PHPExcel_Chart_DataSeriesValues::getDataType ( )

Get Series Data Type.

Returns: string

Definition at line 107 of file DataSeriesValues.php.

                                      {
                return $this->_dataType;
        }

References $_dataType.

◆ getDataValue()

PHPExcel_Chart_DataSeriesValues::getDataValue ( )

Get the first Series Data value.

Returns: mixed

Definition at line 246 of file DataSeriesValues.php.

                                       {
                $count = count($this->_dataValues);
                if ($count == 0) {
                        return null;
                } elseif ($count == 1) {
                        return $this->_dataValues[0];
                }
                return $this->_dataValues;
        }

References $_dataValues.

◆ getDataValues()

PHPExcel_Chart_DataSeriesValues::getDataValues ( )

Get Series Data Values.

Returns: array of mixed

Definition at line 237 of file DataSeriesValues.php.

                                        {
                return $this->_dataValues;
        }

References $_dataValues.

◆ getFormatCode()

PHPExcel_Chart_DataSeriesValues::getFormatCode ( )

Get Series Format Code.

Returns: string

Definition at line 182 of file DataSeriesValues.php.

                                        {
                return $this->_formatCode;
        }

References $_formatCode.

◆ getPointCount()

PHPExcel_Chart_DataSeriesValues::getPointCount ( )

Get Series Point Count.

Returns: integer

Definition at line 203 of file DataSeriesValues.php.

                                        {
                return $this->_pointCount;
        }

References $_pointCount.

◆ getPointMarker()

PHPExcel_Chart_DataSeriesValues::getPointMarker ( )

Get Point Marker.

Returns: string

Definition at line 161 of file DataSeriesValues.php.

                                         {
                return $this->_marker;
        }

References $_marker.

◆ isMultiLevelSeries()

PHPExcel_Chart_DataSeriesValues::isMultiLevelSeries ( )

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

Returns: boolean

Definition at line 212 of file DataSeriesValues.php.

                                             {
                if (count($this->_dataValues) > 0) {
                        return is_array($this->_dataValues[0]);
                }
                return null;
        }

◆ multiLevelCount()

PHPExcel_Chart_DataSeriesValues::multiLevelCount ( )

Return the level count of a multi-level Data Series.

Returns: boolean

Definition at line 224 of file DataSeriesValues.php.

                                          {
                $levelCount = 0;
                foreach($this->_dataValues as $dataValueSet) {
                        $levelCount = max($levelCount,count($dataValueSet));
                }
                return $levelCount;
        }

◆ refresh()

PHPExcel_Chart_DataSeriesValues::refresh	(	PHPExcel_Worksheet	$worksheet,
			$flatten = `TRUE`
	)

Definition at line 280 of file DataSeriesValues.php.

                                                                                {
        if ($this->_dataSource !== NULL) {
                $calcEngine = PHPExcel_Calculation::getInstance($worksheet->getParent());
                        $newDataValues = PHPExcel_Calculation::_unwrapResult(
                            $calcEngine->_calculateFormulaValue(
                                '='.$this->_dataSource,
                                NULL,
                                $worksheet->getCell('A1')
                            )
                        );
                        if ($flatten) {
                                $this->_dataValues = PHPExcel_Calculation_Functions::flattenArray($newDataValues);
                                foreach($this->_dataValues as &$dataValue) {
                                        if ((!empty($dataValue)) && ($dataValue[0] == '#')) {
                                                $dataValue = 0.0;
                                        }
                                }
                                unset($dataValue);
                        } else {
                                $cellRange = explode('!',$this->_dataSource);
                                if (count($cellRange) > 1) {
                                        list(,$cellRange) = $cellRange;
                                }
 
                                $dimensions = PHPExcel_Cell::rangeDimension(str_replace('$','',$cellRange));
                                if (($dimensions[0] == 1) || ($dimensions[1] == 1)) {
                                        $this->_dataValues = PHPExcel_Calculation_Functions::flattenArray($newDataValues);
                                } else {
                                        $newArray = array_values(array_shift($newDataValues));
                                        foreach($newArray as $i => $newDataSet) {
                                                $newArray[$i] = array($newDataSet);
                                        }
 
                                        foreach($newDataValues as $newDataSet) {
                                                $i = 0;
                                                foreach($newDataSet as $newDataVal) {
                                                        array_unshift($newArray[$i++],$newDataVal);
                                                }
                                        }
                                        $this->_dataValues = $newArray;
                                }
                        }
                        $this->_pointCount = count($this->_dataValues);
                }
 
        }

References $i, $worksheet, PHPExcel_Calculation\_unwrapResult(), PHPExcel_Calculation_Functions\flattenArray(), PHPExcel_Calculation\getInstance(), and PHPExcel_Cell\rangeDimension().

Here is the call graph for this function:

◆ setDataSource()

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

Set Series Data Source (formula)

Parameters

string $dataSource

Returns: PHPExcel_Chart_DataSeriesValues

Definition at line 146 of file DataSeriesValues.php.

                                                                                     {
                $this->_dataSource = $dataSource;
 
                if ($refreshDataValues) {
                        //      TO DO
                }
 
                return $this;
        }

◆ setDataType()

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

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

Definition at line 122 of file DataSeriesValues.php.

                                                                            {
                if (!in_array($dataType, self::$_dataTypeValues)) {
                throw new PHPExcel_Chart_Exception('Invalid datatype for chart data series values');
                }
                $this->_dataType = $dataType;
 
                return $this;
        }

Referenced by __construct(), and DataSeriesValuesTest\testGetDataType().

Here is the caller graph for this function:

◆ setDataValues()

PHPExcel_Chart_DataSeriesValues::setDataValues	(	$dataValues = `array()`,
		$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

Returns: PHPExcel_Chart_DataSeriesValues

Definition at line 265 of file DataSeriesValues.php.

                                                                                        {
                $this->_dataValues = PHPExcel_Calculation_Functions::flattenArray($dataValues);
                $this->_pointCount = count($dataValues);
 
                if ($refreshDataSource) {
                        //      TO DO
                }
 
                return $this;
        }

References PHPExcel_Calculation_Functions\flattenArray().

Here is the call graph for this function:

◆ setFormatCode()

PHPExcel_Chart_DataSeriesValues::setFormatCode ( $formatCode = null )

Set Series Format Code.

Parameters

string $formatCode

Returns: PHPExcel_Chart_DataSeriesValues

Definition at line 192 of file DataSeriesValues.php.

                                                          {
                $this->_formatCode = $formatCode;
 
                return $this;
        }

◆ setPointMarker()

PHPExcel_Chart_DataSeriesValues::setPointMarker ( $marker = null )

Set Point Marker.

Parameters

string $marker

Returns: PHPExcel_Chart_DataSeriesValues

Definition at line 171 of file DataSeriesValues.php.

                                                       {
                $this->_marker = $marker;
 
                return $this;
        }

Field Documentation

◆ $_dataSource

PHPExcel_Chart_DataSeriesValues::$_dataSource = null

private

Definition at line 59 of file DataSeriesValues.php.

Referenced by getDataSource().

◆ $_dataType

PHPExcel_Chart_DataSeriesValues::$_dataType = null

private

Definition at line 52 of file DataSeriesValues.php.

Referenced by getDataType().

◆ $_dataTypeValues

PHPExcel_Chart_DataSeriesValues::$_dataTypeValues

staticprivate

Initial value:

= array(
                self::DATASERIES_TYPE_STRING,
                self::DATASERIES_TYPE_NUMBER,
        )

Definition at line 42 of file DataSeriesValues.php.

◆ $_dataValues

PHPExcel_Chart_DataSeriesValues::$_dataValues = array()

private

Definition at line 87 of file DataSeriesValues.php.

Referenced by getDataValue(), and getDataValues().

◆ $_formatCode

PHPExcel_Chart_DataSeriesValues::$_formatCode = null

private

Definition at line 66 of file DataSeriesValues.php.

Referenced by getFormatCode().

◆ $_marker

PHPExcel_Chart_DataSeriesValues::$_marker = null

private

Definition at line 73 of file DataSeriesValues.php.

Referenced by getPointMarker().

◆ $_pointCount

PHPExcel_Chart_DataSeriesValues::$_pointCount = 0

private

Definition at line 80 of file DataSeriesValues.php.

Referenced by getPointCount().

◆ DATASERIES_TYPE_NUMBER

const PHPExcel_Chart_DataSeriesValues::DATASERIES_TYPE_NUMBER = 'Number'

Definition at line 40 of file DataSeriesValues.php.

◆ DATASERIES_TYPE_STRING

const PHPExcel_Chart_DataSeriesValues::DATASERIES_TYPE_STRING = 'String'

Definition at line 39 of file DataSeriesValues.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Chart/DataSeriesValues.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _stripNulls()

◆ getDataSource()

◆ getDataType()

◆ getDataValue()

◆ getDataValues()

◆ getFormatCode()

◆ getPointCount()

◆ getPointMarker()

◆ isMultiLevelSeries()

◆ multiLevelCount()

◆ refresh()

◆ setDataSource()

◆ setDataType()

◆ setDataValues()

◆ setFormatCode()

◆ setPointMarker()

Field Documentation

◆ $_dataSource

◆ $_dataType

◆ $_dataTypeValues

◆ $_dataValues

◆ $_formatCode

◆ $_marker

◆ $_pointCount

◆ DATASERIES_TYPE_NUMBER

◆ DATASERIES_TYPE_STRING