mirror of
https://github.com/Karaka-Management/Resources.git
synced 2026-01-20 00:38:40 +00:00
523 lines
9.9 KiB
PHP
523 lines
9.9 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of PHPPresentation - A pure PHP library for reading and writing
|
|
* presentations documents.
|
|
*
|
|
* PHPPresentation is free software distributed under the terms of the GNU Lesser
|
|
* General Public License version 3 as published by the Free Software Foundation.
|
|
*
|
|
* For the full copyright and license information, please read the LICENSE
|
|
* file that was distributed with this source code. For the full list of
|
|
* contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
|
|
*
|
|
* @see https://github.com/PHPOffice/PHPPresentation
|
|
*
|
|
* @copyright 2009-2015 PHPPresentation contributors
|
|
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpOffice\PhpPresentation\Shape\Chart;
|
|
|
|
use PhpOffice\PhpPresentation\ComparableInterface;
|
|
use PhpOffice\PhpPresentation\Style\Fill;
|
|
use PhpOffice\PhpPresentation\Style\Font;
|
|
use PhpOffice\PhpPresentation\Style\Outline;
|
|
|
|
class Series implements ComparableInterface
|
|
{
|
|
/* Label positions */
|
|
public const LABEL_BESTFIT = 'bestFit';
|
|
public const LABEL_BOTTOM = 'b';
|
|
public const LABEL_CENTER = 'ctr';
|
|
public const LABEL_INSIDEBASE = 'inBase';
|
|
public const LABEL_INSIDEEND = 'inEnd';
|
|
public const LABEL_LEFT = 'i';
|
|
public const LABEL_OUTSIDEEND = 'outEnd';
|
|
public const LABEL_RIGHT = 'r';
|
|
public const LABEL_TOP = 't';
|
|
|
|
/**
|
|
* DataPointFills (key/value).
|
|
*
|
|
* @var array<int, Fill>
|
|
*/
|
|
protected $dataPointFills = [];
|
|
|
|
/**
|
|
* Data Label Number Format.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $DlblNumFormat = '';
|
|
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
protected $separator;
|
|
|
|
/**
|
|
* @var Fill|null
|
|
*/
|
|
protected $fill;
|
|
|
|
/**
|
|
* @var Font|null
|
|
*/
|
|
protected $font;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $labelPosition = 'ctr';
|
|
|
|
/**
|
|
* @var Marker
|
|
*/
|
|
protected $marker;
|
|
|
|
/**
|
|
* @var Outline|null
|
|
*/
|
|
protected $outline;
|
|
|
|
/**
|
|
* Show Category Name.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showCategoryName = false;
|
|
|
|
/**
|
|
* Show Leader Lines.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showLeaderLines = true;
|
|
|
|
/**
|
|
* Show Legend Key.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showLegendKey = false;
|
|
|
|
/**
|
|
* ShowPercentage.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showPercentage = false;
|
|
|
|
/**
|
|
* ShowSeriesName.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showSeriesName = false;
|
|
|
|
/**
|
|
* ShowValue.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $showValue = true;
|
|
|
|
/**
|
|
* Title.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $title = 'Series Title';
|
|
|
|
/**
|
|
* Values (key/value).
|
|
*
|
|
* @var array<string, string|null>
|
|
*/
|
|
private $values = [];
|
|
|
|
/**
|
|
* Hash index.
|
|
*
|
|
* @var int
|
|
*/
|
|
private $hashIndex;
|
|
|
|
/**
|
|
* @param string $title
|
|
* @param array<string, string|null> $values
|
|
*/
|
|
public function __construct(string $title = 'Series Title', array $values = [])
|
|
{
|
|
$this->fill = new Fill();
|
|
$this->font = new Font();
|
|
$this->font->setName('Calibri');
|
|
$this->font->setSize(9);
|
|
$this->marker = new Marker();
|
|
|
|
$this->title = $title;
|
|
$this->values = $values;
|
|
}
|
|
|
|
/**
|
|
* Get Title.
|
|
*/
|
|
public function getTitle(): string
|
|
{
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* Set Title.
|
|
*/
|
|
public function setTitle(string $value = 'Series Title'): self
|
|
{
|
|
$this->title = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Data Label NumFormat.
|
|
*/
|
|
public function getDlblNumFormat(): string
|
|
{
|
|
return $this->DlblNumFormat;
|
|
}
|
|
|
|
/**
|
|
* Has Data Label NumFormat.
|
|
*/
|
|
public function hasDlblNumFormat(): bool
|
|
{
|
|
return !empty($this->DlblNumFormat);
|
|
}
|
|
|
|
/**
|
|
* Set Data Label NumFormat.
|
|
*/
|
|
public function setDlblNumFormat(string $value = ''): self
|
|
{
|
|
$this->DlblNumFormat = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return Fill
|
|
*/
|
|
public function getFill(): ?Fill
|
|
{
|
|
return $this->fill;
|
|
}
|
|
|
|
public function setFill(Fill $fill = null): self
|
|
{
|
|
$this->fill = $fill;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param int $dataPointIndex data point index
|
|
*/
|
|
public function getDataPointFill(int $dataPointIndex): Fill
|
|
{
|
|
if (!isset($this->dataPointFills[$dataPointIndex])) {
|
|
$this->dataPointFills[$dataPointIndex] = new Fill();
|
|
}
|
|
|
|
return $this->dataPointFills[$dataPointIndex];
|
|
}
|
|
|
|
/**
|
|
* @return Fill[]
|
|
*/
|
|
public function getDataPointFills(): array
|
|
{
|
|
return $this->dataPointFills;
|
|
}
|
|
|
|
/**
|
|
* Get Values.
|
|
*
|
|
* @return array<string, string|null>
|
|
*/
|
|
public function getValues(): array
|
|
{
|
|
return $this->values;
|
|
}
|
|
|
|
/**
|
|
* Set Values.
|
|
*
|
|
* @param array<string, string|null> $values
|
|
*/
|
|
public function setValues(array $values = []): self
|
|
{
|
|
$this->values = $values;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add Value.
|
|
*
|
|
* @param string $key
|
|
* @param string|null $value
|
|
*
|
|
* @return self
|
|
*/
|
|
public function addValue(string $key, ?string $value): self
|
|
{
|
|
$this->values[$key] = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get ShowSeriesName.
|
|
*/
|
|
public function hasShowSeriesName(): bool
|
|
{
|
|
return $this->showSeriesName;
|
|
}
|
|
|
|
/**
|
|
* Set ShowSeriesName.
|
|
*/
|
|
public function setShowSeriesName(bool $value): self
|
|
{
|
|
$this->showSeriesName = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get ShowCategoryName.
|
|
*/
|
|
public function hasShowCategoryName(): bool
|
|
{
|
|
return $this->showCategoryName;
|
|
}
|
|
|
|
/**
|
|
* Set ShowCategoryName.
|
|
*/
|
|
public function setShowCategoryName(bool $value): self
|
|
{
|
|
$this->showCategoryName = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get ShowValue.
|
|
*/
|
|
public function hasShowLegendKey(): bool
|
|
{
|
|
return $this->showLegendKey;
|
|
}
|
|
|
|
/**
|
|
* Set ShowValue.
|
|
*/
|
|
public function setShowLegendKey(bool $value): self
|
|
{
|
|
$this->showLegendKey = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get ShowValue.
|
|
*/
|
|
public function hasShowValue(): bool
|
|
{
|
|
return $this->showValue;
|
|
}
|
|
|
|
/**
|
|
* Set ShowValue.
|
|
*/
|
|
public function setShowValue(bool $value): self
|
|
{
|
|
$this->showValue = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get ShowPercentage.
|
|
*/
|
|
public function hasShowPercentage(): bool
|
|
{
|
|
return $this->showPercentage;
|
|
}
|
|
|
|
/**
|
|
* Set ShowPercentage.
|
|
*/
|
|
public function setShowPercentage(bool $value): self
|
|
{
|
|
$this->showPercentage = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function hasShowSeparator(): bool
|
|
{
|
|
return !\is_null($this->separator);
|
|
}
|
|
|
|
public function setSeparator(?string $pValue): self
|
|
{
|
|
$this->separator = $pValue;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getSeparator(): ?string
|
|
{
|
|
return $this->separator;
|
|
}
|
|
|
|
/**
|
|
* Get ShowLeaderLines.
|
|
*/
|
|
public function hasShowLeaderLines(): bool
|
|
{
|
|
return $this->showLeaderLines;
|
|
}
|
|
|
|
/**
|
|
* Set ShowLeaderLines.
|
|
*
|
|
* @param bool $value
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setShowLeaderLines($value)
|
|
{
|
|
$this->showLeaderLines = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get font.
|
|
*
|
|
* @return Font
|
|
*/
|
|
public function getFont(): ?Font
|
|
{
|
|
return $this->font;
|
|
}
|
|
|
|
/**
|
|
* Set font.
|
|
*
|
|
* @param Font|null $pFont Font
|
|
*/
|
|
public function setFont(Font $pFont = null): self
|
|
{
|
|
$this->font = $pFont;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get label position.
|
|
*/
|
|
public function getLabelPosition(): string
|
|
{
|
|
return $this->labelPosition;
|
|
}
|
|
|
|
/**
|
|
* Set label position.
|
|
*/
|
|
public function setLabelPosition(string $value): self
|
|
{
|
|
$this->labelPosition = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getMarker(): Marker
|
|
{
|
|
return $this->marker;
|
|
}
|
|
|
|
public function setMarker(Marker $marker): self
|
|
{
|
|
$this->marker = $marker;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getOutline(): ?Outline
|
|
{
|
|
return $this->outline;
|
|
}
|
|
|
|
public function setOutline(?Outline $outline): self
|
|
{
|
|
$this->outline = $outline;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get hash code.
|
|
*
|
|
* @return string Hash code
|
|
*/
|
|
public function getHashCode(): string
|
|
{
|
|
return \md5((\is_null($this->fill) ? 'null' : $this->fill->getHashCode()) . (\is_null($this->font) ? 'null' : $this->font->getHashCode()) . \var_export($this->values, true) . \var_export($this, true) . __CLASS__);
|
|
}
|
|
|
|
/**
|
|
* Get hash index.
|
|
*
|
|
* Note that this index may vary during script execution! Only reliable moment is
|
|
* while doing a write of a workbook and when changes are not allowed.
|
|
*
|
|
* @return int|null Hash index
|
|
*/
|
|
public function getHashIndex(): ?int
|
|
{
|
|
return $this->hashIndex;
|
|
}
|
|
|
|
/**
|
|
* Set hash index.
|
|
*
|
|
* Note that this index may vary during script execution! Only reliable moment is
|
|
* while doing a write of a workbook and when changes are not allowed.
|
|
*
|
|
* @param int $value Hash index
|
|
*/
|
|
public function setHashIndex(int $value): self
|
|
{
|
|
$this->hashIndex = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @see http://php.net/manual/en/language.oop5.cloning.php
|
|
*/
|
|
public function __clone()
|
|
{
|
|
$this->font = clone $this->font;
|
|
$this->marker = clone $this->marker;
|
|
if (\is_object($this->outline)) {
|
|
$this->outline = clone $this->outline;
|
|
}
|
|
}
|
|
}
|