PlotArea
Table of Contents
- $gapWidth : int|null
- $gradientFillAngle : float|null
- PlotArea Gradient Angle.
- $gradientFillStops : array<string|int, array<string|int, mixed>>
- PlotArea Gradient Stop list.
- $layout : Layout|null
- PlotArea Layout.
- $noFill : bool
- No fill in plot area (show Excel gridlines through chart).
- $plotSeries : array<string|int, DataSeries>
- Plot Series.
- $useDownBars : bool
- $useUpBars : bool
- __construct() : mixed
- Create a new PlotArea.
- getGapWidth() : int|null
- getGradientFillAngle() : float|null
- Get gradientFillAngle.
- getGradientFillStops() : array<string|int, mixed>
- 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
- 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
Properties
$gapWidth
private
int|null
$gapWidth
$gradientFillAngle
PlotArea Gradient Angle.
private
float|null
$gradientFillAngle
$gradientFillStops
PlotArea Gradient Stop list.
private
array<string|int, array<string|int, mixed>>
$gradientFillStops
= []
Each entry is a 2-element array. First is position in %. Second is ChartColor.
$layout
PlotArea Layout.
private
Layout|null
$layout
$noFill
No fill in plot area (show Excel gridlines through chart).
private
bool
$noFill
= false
$plotSeries
Plot Series.
private
array<string|int, DataSeries>
$plotSeries
= []
$useDownBars
private
bool
$useDownBars
= false
$useUpBars
private
bool
$useUpBars
= false
Methods
__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> = []
Return values
mixed —getGapWidth()
public
getGapWidth() : int|null
Return values
int|null —getGradientFillAngle()
Get gradientFillAngle.
public
getGradientFillAngle() : float|null
Return values
float|null —getGradientFillStops()
Get gradientFillStops.
public
getGradientFillStops() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLayout()
public
getLayout() : Layout|null
Return values
Layout|null —getNoFill()
public
getNoFill() : bool
Return values
bool —getPlotGroup()
Get Plot Series.
public
getPlotGroup() : array<string|int, DataSeries>
Return values
array<string|int, DataSeries> —getPlotGroupByIndex()
Get Plot Series by Index.
public
getPlotGroupByIndex(mixed $index) : DataSeries
Parameters
- $index : mixed
Return values
DataSeries —getPlotGroupCount()
Get Number of Plot Groups.
public
getPlotGroupCount() : int
Return values
int —getPlotSeriesCount()
Get Number of Plot Series.
public
getPlotSeriesCount() : int
Return values
int —getUseDownBars()
public
getUseDownBars() : bool
Return values
bool —getUseUpBars()
public
getUseUpBars() : bool
Return values
bool —refresh()
public
refresh(Worksheet $worksheet) : void
Parameters
- $worksheet : Worksheet
Return values
void —setGapWidth()
public
setGapWidth(int|null $gapWidth) : self
Parameters
- $gapWidth : int|null
Return values
self —setGradientFillProperties()
public
setGradientFillProperties(array<string|int, mixed> $gradientFillStops, float|null $gradientFillAngle) : self
Parameters
- $gradientFillStops : array<string|int, mixed>
- $gradientFillAngle : float|null
Return values
self —setNoFill()
public
setNoFill(bool $noFill) : self
Parameters
- $noFill : bool
Return values
self —setPlotSeries()
Set Plot Series.
public
setPlotSeries(array<string|int, DataSeries> $plotSeries) : $this
Parameters
- $plotSeries : array<string|int, DataSeries>
Return values
$this —setUseDownBars()
public
setUseDownBars(bool $useDownBars) : self
Parameters
- $useDownBars : bool
Return values
self —setUseUpBars()
public
setUseUpBars(bool $useUpBars) : self
Parameters
- $useUpBars : bool