PhpOffice\PhpSpreadsheet\Chart\PlotArea Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Chart\PlotArea:

Public Member Functions
	__construct (?Layout $layout=null, array $plotSeries=[])
	Create a new PlotArea. More...
	getLayout ()
	Get Layout. More...
	getPlotGroupCount ()
	Get Number of Plot Groups. More...
	getPlotSeriesCount ()
	Get Number of Plot Series. More...
	getPlotGroup ()
	Get Plot Series. More...
	getPlotGroupByIndex ($index)
	Get Plot Series by Index. More...
	setPlotSeries (array $plotSeries)
	Set Plot Series. More...
	refresh (Worksheet $worksheet)

Private Attributes
	$layout
	$plotSeries = []

Detailed Description

Definition at line 7 of file PlotArea.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::__construct	(	?Layout	$layout = null,
		array	$plotSeries = []
	)

Create a new PlotArea.

Parameters

DataSeries[]

$plotSeries

Definition at line 28 of file PlotArea.php.

References PhpOffice\PhpSpreadsheet\Chart\PlotArea\$layout, and PhpOffice\PhpSpreadsheet\Chart\PlotArea\$plotSeries.

    {
        $this->layout = $layout;
        $this->plotSeries = $plotSeries;
    }

Member Function Documentation

getLayout()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::getLayout

(

)

Get Layout.

Returns

Layout

Definition at line 39 of file PlotArea.php.

References PhpOffice\PhpSpreadsheet\Chart\PlotArea\$layout.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writePlotArea().

    {
        return $this->layout;
    }

Here is the caller graph for this function:

getPlotGroup()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::getPlotGroup

(

)

Get Plot Series.

Returns

DataSeries[]

Definition at line 72 of file PlotArea.php.

References PhpOffice\PhpSpreadsheet\Chart\PlotArea\$plotSeries.

    {
        return $this->plotSeries;
    }

getPlotGroupByIndex()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::getPlotGroupByIndex

(

$index

)

Get Plot Series by Index.

Parameters

mixed

$index

Returns

DataSeries

Definition at line 84 of file PlotArea.php.

References $index.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writePlotArea().

    {
        return $this->plotSeries[$index];
    }

Here is the caller graph for this function:

getPlotGroupCount()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::getPlotGroupCount

(

)

Get Number of Plot Groups.

Definition at line 47 of file PlotArea.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writePlotArea().

                                       : int
    {
        return count($this->plotSeries);
    }

Here is the caller graph for this function:

getPlotSeriesCount()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::getPlotSeriesCount

(

)

Get Number of Plot Series.

Returns

int

Definition at line 57 of file PlotArea.php.

    {
        $seriesCount = 0;
        foreach ($this->plotSeries as $plot) {
            $seriesCount += $plot->getPlotSeriesCount();
        }

        return $seriesCount;
    }

refresh()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::refresh

(

Worksheet

$worksheet

)

Definition at line 103 of file PlotArea.php.

References PhpOffice\PhpSpreadsheet\Chart\PlotArea\$plotSeries.

                                                 : void
    {
        foreach ($this->plotSeries as $plotSeries) {
            $plotSeries->refresh($worksheet);
        }
    }

setPlotSeries()

PhpOffice\PhpSpreadsheet\Chart\PlotArea::setPlotSeries

(

array

$plotSeries

)

Set Plot Series.

Parameters

DataSeries[]

$plotSeries

Returns

$this

Definition at line 96 of file PlotArea.php.

References PhpOffice\PhpSpreadsheet\Chart\PlotArea\$plotSeries.

    {
        $this->plotSeries = $plotSeries;

        return $this;
    }

Field Documentation

$layout

PhpOffice\PhpSpreadsheet\Chart\PlotArea::$layout

private

Definition at line 14 of file PlotArea.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\PlotArea\__construct(), and PhpOffice\PhpSpreadsheet\Chart\PlotArea\getLayout().

$plotSeries

PhpOffice\PhpSpreadsheet\Chart\PlotArea::$plotSeries = []

private

Definition at line 21 of file PlotArea.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\PlotArea\__construct(), PhpOffice\PhpSpreadsheet\Chart\PlotArea\getPlotGroup(), PhpOffice\PhpSpreadsheet\Chart\PlotArea\refresh(), and PhpOffice\PhpSpreadsheet\Chart\PlotArea\setPlotSeries().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Chart/PlotArea.php