PlotArea
in package
Table of Contents
Methods
- __clone() : mixed
- Implement PHP __clone to create a deep clone, not just a shallow copy.
- __construct() : mixed
- Create a new PlotArea.
- getGapWidth() : int|null
- getGradientFillAngle() : float|null
- Get gradientFillAngle.
- getGradientFillStops() : array<string|int, ChartColor}>
- Get gradientFillStops.
- getLayout() : Layout|null
- getNoFill() : bool
- getPlotGroup() : array<string|int, DataSeries>
- Get Plot Series.
- getPlotGroupByIndex() : DataSeries
- Get Plot Series by Index.
- getPlotGroupCount() : int
- Get Number of Plot Groups.
- getPlotSeriesCount() : int|float
- Get Number of Plot Series.
- getUseDownBars() : bool
- getUseUpBars() : bool
- refresh() : void
- setGapWidth() : self
- setGradientFillProperties() : self
- setNoFill() : self
- setPlotSeries() : $this
- Set Plot Series.
- setUseDownBars() : self
- setUseUpBars() : self
Methods
__clone()
Implement PHP __clone to create a deep clone, not just a shallow copy.
public
__clone() : mixed
__construct()
Create a new PlotArea.
public
__construct([Layout|null $layout = null ][, array<string|int, DataSeries> $plotSeries = [] ]) : mixed
Parameters
- $layout : Layout|null = null
- $plotSeries : array<string|int, DataSeries> = []
getGapWidth()
public
getGapWidth() : int|null
Return values
int|nullgetGradientFillAngle()
Get gradientFillAngle.
public
getGradientFillAngle() : float|null
Return values
float|nullgetGradientFillStops()
Get gradientFillStops.
public
getGradientFillStops() : array<string|int, ChartColor}>
Return values
array<string|int, ChartColor}>getLayout()
public
getLayout() : Layout|null
Return values
Layout|nullgetNoFill()
public
getNoFill() : bool
Return values
boolgetPlotGroup()
Get Plot Series.
public
getPlotGroup() : array<string|int, DataSeries>
Return values
array<string|int, DataSeries>getPlotGroupByIndex()
Get Plot Series by Index.
public
getPlotGroupByIndex(int $index) : DataSeries
Parameters
- $index : int
Return values
DataSeriesgetPlotGroupCount()
Get Number of Plot Groups.
public
getPlotGroupCount() : int
Return values
intgetPlotSeriesCount()
Get Number of Plot Series.
public
getPlotSeriesCount() : int|float
Return values
int|floatgetUseDownBars()
public
getUseDownBars() : bool
Return values
boolgetUseUpBars()
public
getUseUpBars() : bool
Return values
boolrefresh()
public
refresh(Worksheet $worksheet) : void
Parameters
- $worksheet : Worksheet
setGapWidth()
public
setGapWidth(int|null $gapWidth) : self
Parameters
- $gapWidth : int|null
Return values
selfsetGradientFillProperties()
public
setGradientFillProperties(array<string|int, ChartColor}> $gradientFillStops, float|null $gradientFillAngle) : self
Parameters
- $gradientFillStops : array<string|int, ChartColor}>
- $gradientFillAngle : float|null
Return values
selfsetNoFill()
public
setNoFill(bool $noFill) : self
Parameters
- $noFill : bool
Return values
selfsetPlotSeries()
Set Plot Series.
public
setPlotSeries(array<string|int, DataSeries> $plotSeries) : $this
Parameters
- $plotSeries : array<string|int, DataSeries>
Return values
$thissetUseDownBars()
public
setUseDownBars(bool $useDownBars) : self
Parameters
- $useDownBars : bool
Return values
selfsetUseUpBars()
public
setUseUpBars(bool $useUpBars) : self
Parameters
- $useUpBars : bool