Collaboration diagram for PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues:

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

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

	setDataType ($dataType)
	Set Series Data Type. More...

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

	setDataSource ($dataSource)
	Set Series Data Source (formula). More...

	getPointMarker ()
	Get Point Marker. More...

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

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

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

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

	getFillColor ()
	Get fill color. More...

	setFillColor ($color)
	Set fill color for series. More...

	getLineWidth ()
	Get line width for series. More...

	setLineWidth ($width)
	Set line width for the series. 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)
	Set Series Data Values. More...

	refresh (Worksheet $worksheet, $flatten=true)

Data Fields
const	DATASERIES_TYPE_STRING = 'String'

const	DATASERIES_TYPE_NUMBER = 'Number'

Private Member Functions
	validateColor ($color)
	Method for validating hex color. More...

Private Attributes
	$dataType

	$dataSource

	$formatCode

	$pointMarker

	$pointCount = 0

	$dataValues = []

	$fillColor

	$lineWidth = 12700

Static Private Attributes
static	$dataTypeValues

Detailed Description

Definition at line 10 of file DataSeriesValues.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::__construct	(	$dataType = `self::DATASERIES_TYPE_NUMBER`,
		$dataSource = `null`,
		$formatCode = `null`,
		$pointCount = `0`,
		$dataValues = `[]`,
		$marker = `null`,
		$fillColor = `null`
	)

Create a new DataSeriesValues object.

Parameters

string	$dataType
string	$dataSource
null \| mixed	$formatCode
int	$pointCount
mixed	$dataValues
null \| mixed	$marker
	null\|string\|string[]	$fillColor

Definition at line 87 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataSource, PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataType, PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataValues, PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$fillColor, PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$formatCode, PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$pointCount, and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setDataType().

     {
         $this->setDataType($dataType);
         $this->dataSource = $dataSource;
         $this->formatCode = $formatCode;
         $this->pointCount = $pointCount;
         $this->dataValues = $dataValues;
         $this->pointMarker = $marker;
         $this->fillColor = $fillColor;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDataSource()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getDataSource ( )

Get Series Data Source (formula).

Returns: string

Definition at line 135 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataSource.

     {
         return $this->dataSource;
     }

◆ getDataType()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getDataType ( )

Get Series Data Type.

Returns: string

Definition at line 103 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataType.

     {
         return $this->dataType;
     }

◆ getDataValue()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getDataValue ( )

Get the first Series Data value.

Returns: mixed

Definition at line 328 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataValues.

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

◆ getDataValues()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getDataValues ( )

Get Series Data Values.

Returns: mixed[]

Definition at line 318 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataValues.

     {
         return $this->dataValues;
     }

◆ getFillColor()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getFillColor ( )

Get fill color.

Returns: string|string[] HEX color or array with HEX colors

Definition at line 217 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$fillColor.

     {
         return $this->fillColor;
     }

◆ getFormatCode()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getFormatCode ( )

Get Series Format Code.

Returns: string

Definition at line 183 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$formatCode.

     {
         return $this->formatCode;
     }

◆ getLineWidth()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getLineWidth ( )

Get line width for series.

Returns: int

Definition at line 264 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$lineWidth.

     {
         return $this->lineWidth;
     }

◆ getPointCount()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getPointCount ( )

Get Series Point Count.

Returns: int

Definition at line 207 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$pointCount.

     {
         return $this->pointCount;
     }

◆ getPointMarker()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::getPointMarker ( )

Get Point Marker.

Returns: string

Definition at line 159 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$pointMarker.

     {
         return $this->pointMarker;
     }

◆ isMultiLevelSeries()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::isMultiLevelSeries ( )

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

Returns: null|bool

Definition at line 289 of file DataSeriesValues.php.

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

◆ multiLevelCount()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::multiLevelCount ( )

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

Returns: int

Definition at line 303 of file DataSeriesValues.php.

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

◆ refresh()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::refresh	(	Worksheet	$worksheet,
			$flatten = `true`
	)

Definition at line 355 of file DataSeriesValues.php.

References $i, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\extractSheetTitle(), PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenArray(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\getInstance(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getParent(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeDimension(), and PhpOffice\PhpSpreadsheet\Calculation\Calculation\unwrapResult().

                                                                   : void
     {
         if ($this->dataSource !== null) {
             $calcEngine = Calculation::getInstance($worksheet->getParent());
             $newDataValues = Calculation::unwrapResult(
                 $calcEngine->_calculateFormulaValue(
                     '=' . $this->dataSource,
                     null,
                     $worksheet->getCell('A1')
                 )
             );
             if ($flatten) {
                 $this->dataValues = Functions::flattenArray($newDataValues);
                 foreach ($this->dataValues as &$dataValue) {
                     if (is_string($dataValue) && !empty($dataValue) && $dataValue[0] == '#') {
                         $dataValue = 0.0;
                     }
                 }
                 unset($dataValue);
             } else {
                 [$worksheet, $cellRange] = Worksheet::extractSheetTitle($this->dataSource, true);
                 $dimensions = Coordinate::rangeDimension(str_replace('$', '', $cellRange));
                 if (($dimensions[0] == 1) || ($dimensions[1] == 1)) {
                     $this->dataValues = Functions::flattenArray($newDataValues);
                 } else {
                     $newArray = array_values(array_shift($newDataValues));
                     foreach ($newArray as $i => $newDataSet) {
                         $newArray[$i] = [$newDataSet];
                     }
 
                     foreach ($newDataValues as $newDataSet) {
                         $i = 0;
                         foreach ($newDataSet as $newDataVal) {
                             array_unshift($newArray[$i++], $newDataVal);
                         }
                     }
                     $this->dataValues = $newArray;
                 }
             }
             $this->pointCount = count($this->dataValues);
         }
     }

Here is the call graph for this function:

◆ setDataSource()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setDataSource ( $dataSource )

Set Series Data Source (formula).

Parameters

string $dataSource

Returns: $this

Definition at line 147 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataSource.

     {
         $this->dataSource = $dataSource;
 
         return $this;
     }

◆ setDataType()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setDataType ( $dataType )

Set Series Data Type.

Parameters

string $dataType Datatype of this data series Typical values are: DataSeriesValues::DATASERIES_TYPE_STRING Normally used for axis point values DataSeriesValues::DATASERIES_TYPE_NUMBER Normally used for chart data values

Returns: $this

Definition at line 120 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataType.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct().

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

Here is the caller graph for this function:

◆ setDataValues()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setDataValues ( $dataValues )

Set Series Data Values.

Parameters

array $dataValues

Returns: $this

Definition at line 347 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$dataValues, and PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenArray().

     {
         $this->dataValues = Functions::flattenArray($dataValues);
         $this->pointCount = count($dataValues);
 
         return $this;
     }

Here is the call graph for this function:

◆ setFillColor()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setFillColor ( $color )

Set fill color for series.

Parameters

string|string[] $color HEX color or array with HEX colors

Returns: DataSeriesValues

Definition at line 229 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\validateColor().

     {
         if (is_array($color)) {
             foreach ($color as $colorValue) {
                 $this->validateColor($colorValue);
             }
         } else {
             $this->validateColor($color);
         }
         $this->fillColor = $color;
 
         return $this;
     }

Here is the call graph for this function:

◆ setFormatCode()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setFormatCode ( $formatCode )

Set Series Format Code.

Parameters

string $formatCode

Returns: $this

Definition at line 195 of file DataSeriesValues.php.

References PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\$formatCode.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\chartDataSeriesValueSet().

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

Here is the caller graph for this function:

◆ setLineWidth()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setLineWidth ( $width )

Set line width for the series.

Parameters

int $width

Returns: $this

Definition at line 276 of file DataSeriesValues.php.

     {
         $minWidth = 12700;
         $this->lineWidth = max($minWidth, $width);
 
         return $this;
     }

◆ setPointMarker()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::setPointMarker ( $marker )

Set Point Marker.

Parameters

string $marker

Returns: $this

Definition at line 171 of file DataSeriesValues.php.

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

◆ validateColor()

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::validateColor ( $color )

private

Method for validating hex color.

Parameters

string $color value for color

Returns: bool true if validation was successful

Definition at line 250 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setFillColor().

     {
         if (!preg_match('/^[a-f0-9]{6}$/i', $color)) {
             throw new Exception(sprintf('Invalid hex color for chart series (color: "%s")', $color));
         }
 
         return true;
     }

Here is the caller graph for this function:

Field Documentation

◆ $dataSource

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$dataSource

private

Definition at line 32 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getDataSource(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setDataSource().

◆ $dataType

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$dataType

private

Definition at line 25 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getDataType(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setDataType().

◆ $dataTypeValues

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$dataTypeValues

staticprivate

Initial value:

= [
        self::DATASERIES_TYPE_STRING,
        self::DATASERIES_TYPE_NUMBER,
    ]

Definition at line 15 of file DataSeriesValues.php.

◆ $dataValues

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$dataValues = []

private

Definition at line 60 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getDataValue(), PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getDataValues(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setDataValues().

◆ $fillColor

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$fillColor

private

Definition at line 67 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getFillColor().

◆ $formatCode

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$formatCode

private

Definition at line 39 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getFormatCode(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\setFormatCode().

◆ $lineWidth

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$lineWidth = 12700

private

Definition at line 74 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getLineWidth().

◆ $pointCount

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$pointCount = 0

private

Definition at line 53 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\__construct(), and PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getPointCount().

◆ $pointMarker

PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::$pointMarker

private

Definition at line 46 of file DataSeriesValues.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\getPointMarker().

◆ DATASERIES_TYPE_NUMBER

const PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER = 'Number'

Definition at line 13 of file DataSeriesValues.php.

◆ DATASERIES_TYPE_STRING

const PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING = 'String'

Definition at line 12 of file DataSeriesValues.php.

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/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

◆ getDataSource()

◆ getDataType()

◆ getDataValue()

◆ getDataValues()

◆ getFillColor()

◆ getFormatCode()

◆ getLineWidth()

◆ getPointCount()

◆ getPointMarker()

◆ isMultiLevelSeries()

◆ multiLevelCount()

◆ refresh()

◆ setDataSource()

◆ setDataType()

◆ setDataValues()

◆ setFillColor()

◆ setFormatCode()

◆ setLineWidth()

◆ setPointMarker()

◆ validateColor()

Field Documentation

◆ $dataSource

◆ $dataType

◆ $dataTypeValues

◆ $dataValues

◆ $fillColor

◆ $formatCode

◆ $lineWidth

◆ $pointCount

◆ $pointMarker

◆ DATASERIES_TYPE_NUMBER

◆ DATASERIES_TYPE_STRING