Documentation

PlotArea
in package

Table of Contents

Properties

$gapWidth  : int|null
$gradientFillAngle  : float|null
PlotArea Gradient Angle.
$gradientFillStops  : array<string|int, ChartColor}>
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

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

Properties

$gapWidth

private int|null $gapWidth = null

$gradientFillAngle

PlotArea Gradient Angle.

private float|null $gradientFillAngle = null

$gradientFillStops

PlotArea Gradient Stop list.

private array<string|int, ChartColor}> $gradientFillStops = []

Each entry is a 2-element array. First is position in %. Second is ChartColor.

$noFill

No fill in plot area (show Excel gridlines through chart).

private bool $noFill = false

$useDownBars

private bool $useDownBars = false

$useUpBars

private bool $useUpBars = false

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|null

getGradientFillAngle()

Get gradientFillAngle.

public getGradientFillAngle() : float|null
Return values
float|null

getGradientFillStops()

Get gradientFillStops.

public getGradientFillStops() : array<string|int, ChartColor}>
Return values
array<string|int, ChartColor}>

getNoFill()

public getNoFill() : bool
Return values
bool

getPlotGroupByIndex()

Get Plot Series by Index.

public getPlotGroupByIndex(int $index) : DataSeries
Parameters
$index : int
Return values
DataSeries

getPlotGroupCount()

Get Number of Plot Groups.

public getPlotGroupCount() : int
Return values
int

getPlotSeriesCount()

Get Number of Plot Series.

public getPlotSeriesCount() : int|float
Return values
int|float

getUseDownBars()

public getUseDownBars() : bool
Return values
bool

getUseUpBars()

public getUseUpBars() : bool
Return values
bool

setGapWidth()

public setGapWidth(int|null $gapWidth) : self
Parameters
$gapWidth : int|null
Return values
self

setGradientFillProperties()

public setGradientFillProperties(array<string|int, ChartColor}> $gradientFillStops, float|null $gradientFillAngle) : self
Parameters
$gradientFillStops : array<string|int, ChartColor}>
$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
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results