Chart::getPlotVisibleOnly() - Code Metrics - Inspection of "Merge pull request #3481 from PHPOffice/NumberForm..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 58ac4c...a7ac5a )

by Mark

created 2023-03-24 01:41 UTC

Chart::getPlotVisibleOnly() A

↳ Parent: Chart

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace PhpOffice\PhpSpreadsheet\Chart;

use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;

class Chart
{
    /**
     * Chart Name.
     *
     * @var string
     */
    private $name = '';

    /**
     * Worksheet.
     *
     * @var ?Worksheet
     */
    private $worksheet;

    /**
     * Chart Title.
     *
     * @var ?Title
     */
    private $title;

    /**
     * Chart Legend.
     *
     * @var ?Legend
     */
    private $legend;

    /**
     * X-Axis Label.
     *
     * @var ?Title
     */
    private $xAxisLabel;

    /**
     * Y-Axis Label.
     *
     * @var ?Title
     */
    private $yAxisLabel;

    /**
     * Chart Plot Area.
     *
     * @var ?PlotArea
     */
    private $plotArea;

    /**
     * Plot Visible Only.
     *
     * @var bool
     */
    private $plotVisibleOnly = true;

    /**
     * Display Blanks as.
     *
     * @var string
     */
    private $displayBlanksAs = DataSeries::EMPTY_AS_GAP;

    /**
     * Chart Asix Y as.
     *
     * @var Axis
     */
    private $yAxis;

    /**
     * Chart Asix X as.
     *
     * @var Axis
     */
    private $xAxis;

    /**
     * Top-Left Cell Position.
     *
     * @var string
     */
    private $topLeftCellRef = 'A1';

    /**
     * Top-Left X-Offset.
     *
     * @var int
     */
    private $topLeftXOffset = 0;

    /**
     * Top-Left Y-Offset.
     *
     * @var int
     */
    private $topLeftYOffset = 0;

    /**
     * Bottom-Right Cell Position.
     *
     * @var string
     */
    private $bottomRightCellRef = '';

    /**
     * Bottom-Right X-Offset.
     *
     * @var int
     */
    private $bottomRightXOffset = 10;

    /**
     * Bottom-Right Y-Offset.
     *
     * @var int
     */
    private $bottomRightYOffset = 10;

    /** @var ?int */
    private $rotX;

    /** @var ?int */
    private $rotY;

    /** @var ?int */
    private $rAngAx;

    /** @var ?int */
    private $perspective;

    /** @var bool */
    private $oneCellAnchor = false;

    /** @var bool */
    private $autoTitleDeleted = false;

    /** @var bool */
    private $noFill = false;

    /** @var bool */
    private $roundedCorners = false;

    /** @var GridLines */
    private $borderLines;

    /** @var ChartColor */
    private $fillColor;

    /**
     * Create a new Chart.
     * majorGridlines and minorGridlines are deprecated, moved to Axis.
     *
     * @param mixed $name
     * @param mixed $plotVisibleOnly
     * @param string $displayBlanksAs
     */
    public function __construct($name, ?Title $title = null, ?Legend $legend = null, ?PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = DataSeries::EMPTY_AS_GAP, ?Title $xAxisLabel = null, ?Title $yAxisLabel = null, ?Axis $xAxis = null, ?Axis $yAxis = null, ?GridLines $majorGridlines = null, ?GridLines $minorGridlines = null)
    {
        $this->name = $name;
        $this->title = $title;
        $this->legend = $legend;
        $this->xAxisLabel = $xAxisLabel;
        $this->yAxisLabel = $yAxisLabel;
        $this->plotArea = $plotArea;
        $this->plotVisibleOnly = $plotVisibleOnly;
        $this->displayBlanksAs = $displayBlanksAs;
        $this->xAxis = $xAxis ?? new Axis();
        $this->yAxis = $yAxis ?? new Axis();
        if ($majorGridlines !== null) {
            $this->yAxis->setMajorGridlines($majorGridlines);
        }
        if ($minorGridlines !== null) {
            $this->yAxis->setMinorGridlines($minorGridlines);
        }
        $this->fillColor = new ChartColor();
        $this->borderLines = new GridLines();
    }

    /**
     * Get Name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get Worksheet.
     */
    public function getWorksheet(): ?Worksheet
    {
        return $this->worksheet;
    }

    /**
     * Set Worksheet.
     *
     * @return $this
     */
    public function setWorksheet(?Worksheet $worksheet = null)
    {
        $this->worksheet = $worksheet;

        return $this;
    }

    public function getTitle(): ?Title
    {
        return $this->title;
    }

    /**
     * Set Title.
     *
     * @return $this
     */
    public function setTitle(Title $title)
    {
        $this->title = $title;

        return $this;
    }

    public function getLegend(): ?Legend
    {
        return $this->legend;
    }

    /**
     * Set Legend.
     *
     * @return $this
     */
    public function setLegend(Legend $legend)
    {
        $this->legend = $legend;

        return $this;
    }

    public function getXAxisLabel(): ?Title
    {
        return $this->xAxisLabel;
    }

    /**
     * Set X-Axis Label.
     *
     * @return $this
     */
    public function setXAxisLabel(Title $label)
    {
        $this->xAxisLabel = $label;

        return $this;
    }

    public function getYAxisLabel(): ?Title
    {
        return $this->yAxisLabel;
    }

    /**
     * Set Y-Axis Label.
     *
     * @return $this
     */
    public function setYAxisLabel(Title $label)
    {
        $this->yAxisLabel = $label;

        return $this;
    }

    public function getPlotArea(): ?PlotArea
    {
        return $this->plotArea;
    }

    /**
     * Set Plot Area.
     */
    public function setPlotArea(PlotArea $plotArea): self
    {
        $this->plotArea = $plotArea;

        return $this;
    }

    /**
     * Get Plot Visible Only.
     *
     * @return bool
     */
    public function getPlotVisibleOnly()
    {
        return $this->plotVisibleOnly;
    }

    /**
     * Set Plot Visible Only.
     *
     * @param bool $plotVisibleOnly
     *
     * @return $this
     */
    public function setPlotVisibleOnly($plotVisibleOnly)
    {
        $this->plotVisibleOnly = $plotVisibleOnly;

        return $this;
    }

    /**
     * Get Display Blanks as.
     *
     * @return string
     */
    public function getDisplayBlanksAs()
    {
        return $this->displayBlanksAs;
    }

    /**
     * Set Display Blanks as.
     *
     * @param string $displayBlanksAs
     *
     * @return $this
     */
    public function setDisplayBlanksAs($displayBlanksAs)
    {
        $this->displayBlanksAs = $displayBlanksAs;

        return $this;
    }

    public function getChartAxisY(): Axis
    {
        return $this->yAxis;
    }

    /**
     * Set yAxis.
     */
    public function setChartAxisY(?Axis $axis): self
    {
        $this->yAxis = $axis ?? new Axis();

        return $this;
    }

    public function getChartAxisX(): Axis
    {
        return $this->xAxis;
    }

    /**
     * Set xAxis.
     */
    public function setChartAxisX(?Axis $axis): self
    {
        $this->xAxis = $axis ?? new Axis();

        return $this;
    }

    /**
     * Get Major Gridlines.
     *
     * @deprecated 1.24.0 Use Axis->getMajorGridlines()
     * @see Axis::getMajorGridlines()
     *
     * @codeCoverageIgnore
     */
    public function getMajorGridlines(): ?GridLines
    {
        return $this->yAxis->getMajorGridLines();
    }

    /**
     * Get Minor Gridlines.
     *
     * @deprecated 1.24.0 Use Axis->getMinorGridlines()
     * @see Axis::getMinorGridlines()
     *
     * @codeCoverageIgnore
     */
    public function getMinorGridlines(): ?GridLines
    {
        return $this->yAxis->getMinorGridLines();
    }

    /**
     * Set the Top Left position for the chart.
     *
     * @param string $cellAddress
     * @param int $xOffset
     * @param int $yOffset
     *
     * @return $this
     */
    public function setTopLeftPosition($cellAddress, $xOffset = null, $yOffset = null)
    {
        $this->topLeftCellRef = $cellAddress;
        if ($xOffset !== null) {
            $this->setTopLeftXOffset($xOffset);
        }
        if ($yOffset !== null) {
            $this->setTopLeftYOffset($yOffset);
        }

        return $this;
    }

    /**
     * Get the top left position of the chart.
     *
     * Returns ['cell' => string cell address, 'xOffset' => int, 'yOffset' => int].
     *
     * @return array{cell: string, xOffset: int, yOffset: int} an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
     */
    public function getTopLeftPosition(): array
    {
        return [
            'cell' => $this->topLeftCellRef,
            'xOffset' => $this->topLeftXOffset,
            'yOffset' => $this->topLeftYOffset,
        ];
    }

    /**
     * Get the cell address where the top left of the chart is fixed.
     *
     * @return string
     */
    public function getTopLeftCell()
    {
        return $this->topLeftCellRef;
    }

    /**
     * Set the Top Left cell position for the chart.
     *
     * @param string $cellAddress
     *
     * @return $this
     */
    public function setTopLeftCell($cellAddress)
    {
        $this->topLeftCellRef = $cellAddress;

        return $this;
    }

    /**
     * Set the offset position within the Top Left cell for the chart.
     *
     * @param ?int $xOffset
     * @param ?int $yOffset
     *
     * @return $this
     */
    public function setTopLeftOffset($xOffset, $yOffset)
    {
        if ($xOffset !== null) {
            $this->setTopLeftXOffset($xOffset);
        }

        if ($yOffset !== null) {
            $this->setTopLeftYOffset($yOffset);
        }

        return $this;
    }

    /**
     * Get the offset position within the Top Left cell for the chart.
     *
     * @return int[]
     */
    public function getTopLeftOffset()
    {
        return [
            'X' => $this->topLeftXOffset,
            'Y' => $this->topLeftYOffset,
        ];
    }

    /**
     * @param int $xOffset
     *
     * @return $this
     */
    public function setTopLeftXOffset($xOffset)
    {
        $this->topLeftXOffset = $xOffset;

        return $this;
    }

    public function getTopLeftXOffset(): int
    {
        return $this->topLeftXOffset;
    }

    /**
     * @param int $yOffset
     *
     * @return $this
     */
    public function setTopLeftYOffset($yOffset)
    {
        $this->topLeftYOffset = $yOffset;

        return $this;
    }

    public function getTopLeftYOffset(): int
    {
        return $this->topLeftYOffset;
    }

    /**
     * Set the Bottom Right position of the chart.
     *
     * @param string $cellAddress
     * @param int $xOffset
     * @param int $yOffset
     *
     * @return $this
     */
    public function setBottomRightPosition($cellAddress = '', $xOffset = null, $yOffset = null)
    {
        $this->bottomRightCellRef = $cellAddress;
        if ($xOffset !== null) {
            $this->setBottomRightXOffset($xOffset);
        }
        if ($yOffset !== null) {
            $this->setBottomRightYOffset($yOffset);
        }

        return $this;
    }

    /**
     * Get the bottom right position of the chart.
     *
     * @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
     */
    public function getBottomRightPosition()
    {
        return [
            'cell' => $this->bottomRightCellRef,
            'xOffset' => $this->bottomRightXOffset,
            'yOffset' => $this->bottomRightYOffset,
        ];
    }

    /**
     * Set the Bottom Right cell for the chart.
     *
     * @return $this
     */
    public function setBottomRightCell(string $cellAddress = '')
    {
        $this->bottomRightCellRef = $cellAddress;

        return $this;
    }

    /**
     * Get the cell address where the bottom right of the chart is fixed.
     */
    public function getBottomRightCell(): string
    {
        return $this->bottomRightCellRef;
    }

    /**
     * Set the offset position within the Bottom Right cell for the chart.
     *
     * @param ?int $xOffset
     * @param ?int $yOffset
     *
     * @return $this
     */
    public function setBottomRightOffset($xOffset, $yOffset)
    {
        if ($xOffset !== null) {
            $this->setBottomRightXOffset($xOffset);
        }

        if ($yOffset !== null) {
            $this->setBottomRightYOffset($yOffset);
        }

        return $this;
    }

    /**
     * Get the offset position within the Bottom Right cell for the chart.
     *
     * @return int[]
     */
    public function getBottomRightOffset()
    {
        return [
            'X' => $this->bottomRightXOffset,
            'Y' => $this->bottomRightYOffset,
        ];
    }

    /**
     * @param int $xOffset
     *
     * @return $this
     */
    public function setBottomRightXOffset($xOffset)
    {
        $this->bottomRightXOffset = $xOffset;

        return $this;
    }

    public function getBottomRightXOffset(): int
    {
        return $this->bottomRightXOffset;
    }

    /**
     * @param int $yOffset
     *
     * @return $this
     */
    public function setBottomRightYOffset($yOffset)
    {
        $this->bottomRightYOffset = $yOffset;

        return $this;
    }

    public function getBottomRightYOffset(): int
    {
        return $this->bottomRightYOffset;
    }

    public function refresh(): void
    {
        if ($this->worksheet !== null && $this->plotArea !== null) {
            $this->plotArea->refresh($this->worksheet);
        }
    }

    /**
     * Render the chart to given file (or stream).
     *
     * @param string $outputDestination Name of the file render to
     *
     * @return bool true on success
     */
    public function render($outputDestination = null)
    {
        if ($outputDestination == 'php://output') {
            $outputDestination = null;
        }

        $libraryName = Settings::getChartRenderer();
        if ($libraryName === null) {
            return false;
        }

        // Ensure that data series values are up-to-date before we render
        $this->refresh();

        $renderer = new $libraryName($this);

        return $renderer->render($outputDestination); // @phpstan-ignore-line
    }

    public function getRotX(): ?int
    {
        return $this->rotX;
    }

    public function setRotX(?int $rotX): self
    {
        $this->rotX = $rotX;

        return $this;
    }

    public function getRotY(): ?int
    {
        return $this->rotY;
    }

    public function setRotY(?int $rotY): self
    {
        $this->rotY = $rotY;

        return $this;
    }

    public function getRAngAx(): ?int
    {
        return $this->rAngAx;
    }

    public function setRAngAx(?int $rAngAx): self
    {
        $this->rAngAx = $rAngAx;

        return $this;
    }

    public function getPerspective(): ?int
    {
        return $this->perspective;
    }

    public function setPerspective(?int $perspective): self
    {
        $this->perspective = $perspective;

        return $this;
    }

    public function getOneCellAnchor(): bool
    {
        return $this->oneCellAnchor;
    }

    public function setOneCellAnchor(bool $oneCellAnchor): self
    {
        $this->oneCellAnchor = $oneCellAnchor;

        return $this;
    }

    public function getAutoTitleDeleted(): bool
    {
        return $this->autoTitleDeleted;
    }

    public function setAutoTitleDeleted(bool $autoTitleDeleted): self
    {
        $this->autoTitleDeleted = $autoTitleDeleted;

        return $this;
    }

    public function getNoFill(): bool
    {
        return $this->noFill;
    }

    public function setNoFill(bool $noFill): self
    {
        $this->noFill = $noFill;

        return $this;
    }

    public function getRoundedCorners(): bool
    {
        return $this->roundedCorners;
    }

    public function setRoundedCorners(?bool $roundedCorners): self
    {
        if ($roundedCorners !== null) {
            $this->roundedCorners = $roundedCorners;
        }

        return $this;
    }

    public function getBorderLines(): GridLines
    {
        return $this->borderLines;
    }

    public function setBorderLines(GridLines $borderLines): self
    {
        $this->borderLines = $borderLines;

        return $this;
    }

    public function getFillColor(): ChartColor
    {
        return $this->fillColor;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Chart;
4
5		use PhpOffice\PhpSpreadsheet\Settings;
6		use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
7
8		class Chart
9		{
10		/**
11		* Chart Name.
12		*
13		* @var string
14		*/
15		private $name = '';
16
17		/**
18		* Worksheet.
19		*
20		* @var ?Worksheet
21		*/
22		private $worksheet;
23
24		/**
25		* Chart Title.
26		*
27		* @var ?Title
28		*/
29		private $title;
30
31		/**
32		* Chart Legend.
33		*
34		* @var ?Legend
35		*/
36		private $legend;
37
38		/**
39		* X-Axis Label.
40		*
41		* @var ?Title
42		*/
43		private $xAxisLabel;
44
45		/**
46		* Y-Axis Label.
47		*
48		* @var ?Title
49		*/
50		private $yAxisLabel;
51
52		/**
53		* Chart Plot Area.
54		*
55		* @var ?PlotArea
56		*/
57		private $plotArea;
58
59		/**
60		* Plot Visible Only.
61		*
62		* @var bool
63		*/
64		private $plotVisibleOnly = true;
65
66		/**
67		* Display Blanks as.
68		*
69		* @var string
70		*/
71		private $displayBlanksAs = DataSeries::EMPTY_AS_GAP;
72
73		/**
74		* Chart Asix Y as.
75		*
76		* @var Axis
77		*/
78		private $yAxis;
79
80		/**
81		* Chart Asix X as.
82		*
83		* @var Axis
84		*/
85		private $xAxis;
86
87		/**
88		* Top-Left Cell Position.
89		*
90		* @var string
91		*/
92		private $topLeftCellRef = 'A1';
93
94		/**
95		* Top-Left X-Offset.
96		*
97		* @var int
98		*/
99		private $topLeftXOffset = 0;
100
101		/**
102		* Top-Left Y-Offset.
103		*
104		* @var int
105		*/
106		private $topLeftYOffset = 0;
107
108		/**
109		* Bottom-Right Cell Position.
110		*
111		* @var string
112		*/
113		private $bottomRightCellRef = '';
114
115		/**
116		* Bottom-Right X-Offset.
117		*
118		* @var int
119		*/
120		private $bottomRightXOffset = 10;
121
122		/**
123		* Bottom-Right Y-Offset.
124		*
125		* @var int
126		*/
127		private $bottomRightYOffset = 10;
128
129		/** @var ?int */
130		private $rotX;
131
132		/** @var ?int */
133		private $rotY;
134
135		/** @var ?int */
136		private $rAngAx;
137
138		/** @var ?int */
139		private $perspective;
140
141		/** @var bool */
142		private $oneCellAnchor = false;
143
144		/** @var bool */
145		private $autoTitleDeleted = false;
146
147		/** @var bool */
148		private $noFill = false;
149
150		/** @var bool */
151		private $roundedCorners = false;
152
153		/** @var GridLines */
154		private $borderLines;
155
156		/** @var ChartColor */
157		private $fillColor;
158
159		/**
160		* Create a new Chart.
161		* majorGridlines and minorGridlines are deprecated, moved to Axis.
162		*
163		* @param mixed $name
164		* @param mixed $plotVisibleOnly
165		* @param string $displayBlanksAs
166		*/
167	88	public function __construct($name, ?Title $title = null, ?Legend $legend = null, ?PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = DataSeries::EMPTY_AS_GAP, ?Title $xAxisLabel = null, ?Title $yAxisLabel = null, ?Axis $xAxis = null, ?Axis $yAxis = null, ?GridLines $majorGridlines = null, ?GridLines $minorGridlines = null)
168		{
169	88	$this->name = $name;
170	88	$this->title = $title;
171	88	$this->legend = $legend;
172	88	$this->xAxisLabel = $xAxisLabel;
173	88	$this->yAxisLabel = $yAxisLabel;
174	88	$this->plotArea = $plotArea;
175	88	$this->plotVisibleOnly = $plotVisibleOnly;
176	88	$this->displayBlanksAs = $displayBlanksAs;
177	88	$this->xAxis = $xAxis ?? new Axis();
178	88	$this->yAxis = $yAxis ?? new Axis();
179	88	if ($majorGridlines !== null) {
180	1	$this->yAxis->setMajorGridlines($majorGridlines);
181		}
182	88	if ($minorGridlines !== null) {
183	1	$this->yAxis->setMinorGridlines($minorGridlines);
184		}
185	88	$this->fillColor = new ChartColor();
186	88	$this->borderLines = new GridLines();
187		}
188
189		/**
190		* Get Name.
191		*
192		* @return string
193		*/
194	4	public function getName()
195		{
196	4	return $this->name;
197		}
198
199	1	public function setName(string $name): self
200		{
201	1	$this->name = $name;
202
203	1	return $this;
204		}
205
206		/**
207		* Get Worksheet.
208		*/
209	1	public function getWorksheet(): ?Worksheet
210		{
211	1	return $this->worksheet;
212		}
213
214		/**
215		* Set Worksheet.
216		*
217		* @return $this
218		*/
219	85	public function setWorksheet(?Worksheet $worksheet = null)
220		{
221	85	$this->worksheet = $worksheet;
222
223	85	return $this;
224		}
225
226	82	public function getTitle(): ?Title
227		{
228	82	return $this->title;
229		}
230
231		/**
232		* Set Title.
233		*
234		* @return $this
235		*/
236	1	public function setTitle(Title $title)
237		{
238	1	$this->title = $title;
239
240	1	return $this;
241		}
242
243	79	public function getLegend(): ?Legend
244		{
245	79	return $this->legend;
246		}
247
248		/**
249		* Set Legend.
250		*
251		* @return $this
252		*/
253	1	public function setLegend(Legend $legend)
254		{
255	1	$this->legend = $legend;
256
257	1	return $this;
258		}
259
260	80	public function getXAxisLabel(): ?Title
261		{
262	80	return $this->xAxisLabel;
263		}
264
265		/**
266		* Set X-Axis Label.
267		*
268		* @return $this
269		*/
270	1	public function setXAxisLabel(Title $label)
271		{
272	1	$this->xAxisLabel = $label;
273
274	1	return $this;
275		}
276
277	80	public function getYAxisLabel(): ?Title
278		{
279	80	return $this->yAxisLabel;
280		}
281
282		/**
283		* Set Y-Axis Label.
284		*
285		* @return $this
286		*/
287	1	public function setYAxisLabel(Title $label)
288		{
289	1	$this->yAxisLabel = $label;
290
291	1	return $this;
292		}
293
294	81	public function getPlotArea(): ?PlotArea
295		{
296	81	return $this->plotArea;
297		}
298
299		/**
300		* Set Plot Area.
301		*/
302	2	public function setPlotArea(PlotArea $plotArea): self
303		{
304	2	$this->plotArea = $plotArea;
305
306	2	return $this;
307		}
308
309		/**
310		* Get Plot Visible Only.
311		*
312		* @return bool
313		*/
314	76	public function getPlotVisibleOnly()
315		{
316	76	return $this->plotVisibleOnly;
317		}
318
319		/**
320		* Set Plot Visible Only.
321		*
322		* @param bool $plotVisibleOnly
323		*
324		* @return $this
325		*/
326	1	public function setPlotVisibleOnly($plotVisibleOnly)
327		{
328	1	$this->plotVisibleOnly = $plotVisibleOnly;
329
330	1	return $this;
331		}
332
333		/**
334		* Get Display Blanks as.
335		*
336		* @return string
337		*/
338	76	public function getDisplayBlanksAs()
339		{
340	76	return $this->displayBlanksAs;
341		}
342
343		/**
344		* Set Display Blanks as.
345		*
346		* @param string $displayBlanksAs
347		*
348		* @return $this
349		*/
350	1	public function setDisplayBlanksAs($displayBlanksAs)
351		{
352	1	$this->displayBlanksAs = $displayBlanksAs;
353
354	1	return $this;
355		}
356
357	76	public function getChartAxisY(): Axis
358		{
359	76	return $this->yAxis;
360		}
361
362		/**
363		* Set yAxis.
364		*/
365	1	public function setChartAxisY(?Axis $axis): self
366		{
367	1	$this->yAxis = $axis ?? new Axis();
368
369	1	return $this;
370		}
371
372	76	public function getChartAxisX(): Axis
373		{
374	76	return $this->xAxis;
375		}
376
377		/**
378		* Set xAxis.
379		*/
380	1	public function setChartAxisX(?Axis $axis): self
381		{
382	1	$this->xAxis = $axis ?? new Axis();
383
384	1	return $this;
385		}
386
387		/**
388		* Get Major Gridlines.
389		*
390		* @deprecated 1.24.0 Use Axis->getMajorGridlines()
391		* @see Axis::getMajorGridlines()
392		*
393		* @codeCoverageIgnore
394		*/
395		public function getMajorGridlines(): ?GridLines
396		{
397		return $this->yAxis->getMajorGridLines();
398		}
399
400		/**
401		* Get Minor Gridlines.
402		*
403		* @deprecated 1.24.0 Use Axis->getMinorGridlines()
404		* @see Axis::getMinorGridlines()
405		*
406		* @codeCoverageIgnore
407		*/
408		public function getMinorGridlines(): ?GridLines
409		{
410		return $this->yAxis->getMinorGridLines();
411		}
412
413		/**
414		* Set the Top Left position for the chart.
415		*
416		* @param string $cellAddress
417		* @param int $xOffset
418		* @param int $yOffset
419		*
420		* @return $this
421		*/
422	84	public function setTopLeftPosition($cellAddress, $xOffset = null, $yOffset = null)
423		{
424	84	$this->topLeftCellRef = $cellAddress;
425	84	if ($xOffset !== null) {
426	54	$this->setTopLeftXOffset($xOffset);
427		}
428	84	if ($yOffset !== null) {
429	54	$this->setTopLeftYOffset($yOffset);
430		}
431
432	84	return $this;
433		}
434
435		/**
436		* Get the top left position of the chart.
437		*
438		* Returns ['cell' => string cell address, 'xOffset' => int, 'yOffset' => int].
439		*
440		* @return array{cell: string, xOffset: int, yOffset: int} an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
441		*/
442	65	public function getTopLeftPosition(): array
443		{
444	65	return [
445	65	'cell' => $this->topLeftCellRef,
446	65	'xOffset' => $this->topLeftXOffset,
447	65	'yOffset' => $this->topLeftYOffset,
448	65	];
449		}
450
451		/**
452		* Get the cell address where the top left of the chart is fixed.
453		*
454		* @return string
455		*/
456	2	public function getTopLeftCell()
457		{
458	2	return $this->topLeftCellRef;
459		}
460
461		/**
462		* Set the Top Left cell position for the chart.
463		*
464		* @param string $cellAddress
465		*
466		* @return $this
467		*/
468	1	public function setTopLeftCell($cellAddress)
469		{
470	1	$this->topLeftCellRef = $cellAddress;
471
472	1	return $this;
473		}
474
475		/**
476		* Set the offset position within the Top Left cell for the chart.
477		*
478		* @param ?int $xOffset
479		* @param ?int $yOffset
480		*
481		* @return $this
482		*/
483	1	public function setTopLeftOffset($xOffset, $yOffset)
484		{
485	1	if ($xOffset !== null) {
486	1	$this->setTopLeftXOffset($xOffset);
487		}
488
489	1	if ($yOffset !== null) {
490	1	$this->setTopLeftYOffset($yOffset);
491		}
492
493	1	return $this;
494		}
495
496		/**
497		* Get the offset position within the Top Left cell for the chart.
498		*
499		* @return int[]
500		*/
501	1	public function getTopLeftOffset()
502		{
503	1	return [
504	1	'X' => $this->topLeftXOffset,
505	1	'Y' => $this->topLeftYOffset,
506	1	];
507		}
508
509		/**
510		* @param int $xOffset
511		*
512		* @return $this
513		*/
514	54	public function setTopLeftXOffset($xOffset)
515		{
516	54	$this->topLeftXOffset = $xOffset;
517
518	54	return $this;
519		}
520
521	1	public function getTopLeftXOffset(): int
522		{
523	1	return $this->topLeftXOffset;
524		}
525
526		/**
527		* @param int $yOffset
528		*
529		* @return $this
530		*/
531	54	public function setTopLeftYOffset($yOffset)
532		{
533	54	$this->topLeftYOffset = $yOffset;
534
535	54	return $this;
536		}
537
538	1	public function getTopLeftYOffset(): int
539		{
540	1	return $this->topLeftYOffset;
541		}
542
543		/**
544		* Set the Bottom Right position of the chart.
545		*
546		* @param string $cellAddress
547		* @param int $xOffset
548		* @param int $yOffset
549		*
550		* @return $this
551		*/
552	84	public function setBottomRightPosition($cellAddress = '', $xOffset = null, $yOffset = null)
553		{
554	84	$this->bottomRightCellRef = $cellAddress;
555	84	if ($xOffset !== null) {
556	54	$this->setBottomRightXOffset($xOffset);
557		}
558	84	if ($yOffset !== null) {
559	54	$this->setBottomRightYOffset($yOffset);
560		}
561
562	84	return $this;
563		}
564
565		/**
566		* Get the bottom right position of the chart.
567		*
568		* @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
569		*/
570	63	public function getBottomRightPosition()
571		{
572	63	return [
573	63	'cell' => $this->bottomRightCellRef,
574	63	'xOffset' => $this->bottomRightXOffset,
575	63	'yOffset' => $this->bottomRightYOffset,
576	63	];
577		}
578
579		/**
580		* Set the Bottom Right cell for the chart.
581		*
582		* @return $this
583		*/
584	1	public function setBottomRightCell(string $cellAddress = '')
585		{
586	1	$this->bottomRightCellRef = $cellAddress;
587
588	1	return $this;
589		}
590
591		/**
592		* Get the cell address where the bottom right of the chart is fixed.
593		*/
594	2	public function getBottomRightCell(): string
595		{
596	2	return $this->bottomRightCellRef;
597		}
598
599		/**
600		* Set the offset position within the Bottom Right cell for the chart.
601		*
602		* @param ?int $xOffset
603		* @param ?int $yOffset
604		*
605		* @return $this
606		*/
607	1	public function setBottomRightOffset($xOffset, $yOffset)
608		{
609	1	if ($xOffset !== null) {
610	1	$this->setBottomRightXOffset($xOffset);
611		}
612
613	1	if ($yOffset !== null) {
614	1	$this->setBottomRightYOffset($yOffset);
615		}
616
617	1	return $this;
618		}
619
620		/**
621		* Get the offset position within the Bottom Right cell for the chart.
622		*
623		* @return int[]
624		*/
625	1	public function getBottomRightOffset()
626		{
627	1	return [
628	1	'X' => $this->bottomRightXOffset,
629	1	'Y' => $this->bottomRightYOffset,
630	1	];
631		}
632
633		/**
634		* @param int $xOffset
635		*
636		* @return $this
637		*/
638	54	public function setBottomRightXOffset($xOffset)
639		{
640	54	$this->bottomRightXOffset = $xOffset;
641
642	54	return $this;
643		}
644
645	1	public function getBottomRightXOffset(): int
646		{
647	1	return $this->bottomRightXOffset;
648		}
649
650		/**
651		* @param int $yOffset
652		*
653		* @return $this
654		*/
655	54	public function setBottomRightYOffset($yOffset)
656		{
657	54	$this->bottomRightYOffset = $yOffset;
658
659	54	return $this;
660		}
661
662	1	public function getBottomRightYOffset(): int
663		{
664	1	return $this->bottomRightYOffset;
665		}
666
667	79	public function refresh(): void
668		{
669	79	if ($this->worksheet !== null && $this->plotArea !== null) {
670	79	$this->plotArea->refresh($this->worksheet);
671		}
672		}
673
674		/**
675		* Render the chart to given file (or stream).
676		*
677		* @param string $outputDestination Name of the file render to
678		*
679		* @return bool true on success
680		*/
681	4	public function render($outputDestination = null)
682		{
683	4	if ($outputDestination == 'php://output') {
684		$outputDestination = null;
685		}
686
687	4	$libraryName = Settings::getChartRenderer();
688	4	if ($libraryName === null) {
689	1	return false;
690		}
691
692		// Ensure that data series values are up-to-date before we render
693	3	$this->refresh();
694
695	3	$renderer = new $libraryName($this);
696
697	3	return $renderer->render($outputDestination); // @phpstan-ignore-line
698		}
699
700	76	public function getRotX(): ?int
701		{
702	76	return $this->rotX;
703		}
704
705	6	public function setRotX(?int $rotX): self
706		{
707	6	$this->rotX = $rotX;
708
709	6	return $this;
710		}
711
712	76	public function getRotY(): ?int
713		{
714	76	return $this->rotY;
715		}
716
717	6	public function setRotY(?int $rotY): self
718		{
719	6	$this->rotY = $rotY;
720
721	6	return $this;
722		}
723
724	76	public function getRAngAx(): ?int
725		{
726	76	return $this->rAngAx;
727		}
728
729	6	public function setRAngAx(?int $rAngAx): self
730		{
731	6	$this->rAngAx = $rAngAx;
732
733	6	return $this;
734		}
735
736	76	public function getPerspective(): ?int
737		{
738	76	return $this->perspective;
739		}
740
741	2	public function setPerspective(?int $perspective): self
742		{
743	2	$this->perspective = $perspective;
744
745	2	return $this;
746		}
747
748	4	public function getOneCellAnchor(): bool
749		{
750	4	return $this->oneCellAnchor;
751		}
752
753	3	public function setOneCellAnchor(bool $oneCellAnchor): self
754		{
755	3	$this->oneCellAnchor = $oneCellAnchor;
756
757	3	return $this;
758		}
759
760	76	public function getAutoTitleDeleted(): bool
761		{
762	76	return $this->autoTitleDeleted;
763		}
764
765	51	public function setAutoTitleDeleted(bool $autoTitleDeleted): self
766		{
767	51	$this->autoTitleDeleted = $autoTitleDeleted;
768
769	51	return $this;
770		}
771
772	76	public function getNoFill(): bool
773		{
774	76	return $this->noFill;
775		}
776
777	4	public function setNoFill(bool $noFill): self
778		{
779	4	$this->noFill = $noFill;
780
781	4	return $this;
782		}
783
784	76	public function getRoundedCorners(): bool
785		{
786	76	return $this->roundedCorners;
787		}
788
789	54	public function setRoundedCorners(?bool $roundedCorners): self
790		{
791	54	if ($roundedCorners !== null) {
792	54	$this->roundedCorners = $roundedCorners;
793		}
794
795	54	return $this;
796		}
797
798	76	public function getBorderLines(): GridLines
799		{
800	76	return $this->borderLines;
801		}
802
803	37	public function setBorderLines(GridLines $borderLines): self
804		{
805	37	$this->borderLines = $borderLines;
806
807	37	return $this;
808		}
809
810	79	public function getFillColor(): ChartColor
811		{
812	79	return $this->fillColor;
813		}
814		}
815

PHPOffice / PhpSpreadsheet

Push — master ( 58ac4c...a7ac5a )

Chart::getPlotVisibleOnly() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like