DataSeries
in package
Table of Contents
Constants
- DIRECTION_BAR = 'bar'
- DIRECTION_COL = 'col'
- DIRECTION_COLUMN = self::DIRECTION_COL
- DIRECTION_HORIZONTAL = self::DIRECTION_BAR
- DIRECTION_VERTICAL = self::DIRECTION_COL
- EMPTY_AS_GAP = 'gap'
- EMPTY_AS_SPAN = 'span'
- EMPTY_AS_ZERO = 'zero'
- GROUPING_CLUSTERED = 'clustered'
- GROUPING_PERCENT_STACKED = 'percentStacked'
- GROUPING_STACKED = 'stacked'
- GROUPING_STANDARD = 'standard'
- STYLE_FILLED = 'filled'
- STYLE_LINEMARKER = 'lineMarker'
- STYLE_MARKER = 'marker'
- STYLE_SMOOTHMARKER = 'smoothMarker'
- TYPE_AREACHART = 'areaChart'
- TYPE_AREACHART_3D = 'area3DChart'
- TYPE_BARCHART = 'barChart'
- TYPE_BARCHART_3D = 'bar3DChart'
- TYPE_BUBBLECHART = 'bubbleChart'
- TYPE_CANDLECHART = self::TYPE_STOCKCHART
- TYPE_DONUTCHART = self::TYPE_DOUGHNUTCHART
- TYPE_DOUGHNUTCHART = 'doughnutChart'
- TYPE_LINECHART = 'lineChart'
- TYPE_LINECHART_3D = 'line3DChart'
- TYPE_PIECHART = 'pieChart'
- TYPE_PIECHART_3D = 'pie3DChart'
- TYPE_RADARCHART = 'radarChart'
- TYPE_SCATTERCHART = 'scatterChart'
- TYPE_STOCKCHART = 'stockChart'
- TYPE_SURFACECHART = 'surfaceChart'
- TYPE_SURFACECHART_3D = 'surface3DChart'
Properties
- $plotBubbleSizes : array<string|int, DataSeriesValues>
- Plot Bubble Sizes.
- $plotCategory : array<string|int, DataSeriesValues>
- Plot Category.
- $plotDirection : string
- Plot Direction.
- $plotGrouping : string|null
- Plot Grouping Type.
- $plotLabel : array<string|int, DataSeriesValues>
- Plot Label.
- $plotOrder : array<string|int, int>
- Order of plots in Series.
- $plotStyle : string|null
- Plot Style.
- $plotType : string|null
- Series Plot Type.
- $plotValues : array<string|int, DataSeriesValues>
- Plot Values.
- $smoothLine : bool
- Smooth Line. Must be specified for both DataSeries and DataSeriesValues.
Methods
- __clone() : mixed
- Implement PHP __clone to create a deep clone, not just a shallow copy.
- __construct() : mixed
- Create a new DataSeries.
- getPlotBubbleSizes() : array<string|int, DataSeriesValues>
- Get Plot Bubble Sizes.
- getPlotCategories() : array<string|int, DataSeriesValues>
- Get Plot Categories.
- getPlotCategoryByIndex() : DataSeriesValues|false
- Get Plot Category by Index.
- getPlotDirection() : string
- Get Plot Direction.
- getPlotGrouping() : string|null
- Get Plot Grouping Type.
- getPlotLabelByIndex() : DataSeriesValues|false
- Get Plot Label by Index.
- getPlotLabels() : array<string|int, DataSeriesValues>
- Get Plot Labels.
- getPlotOrder() : array<string|int, int>
- Get Plot Order.
- getPlotSeriesCount() : int
- Get Number of Plot Series.
- getPlotStyle() : string|null
- Get Plot Style.
- getPlotType() : string|null
- Get Plot Type.
- getPlotValues() : array<string|int, DataSeriesValues>
- Get Plot Values.
- getPlotValuesByIndex() : DataSeriesValues|false
- Get Plot Values by Index.
- getSmoothLine() : bool
- Get Smooth Line.
- refresh() : void
- setPlotBubbleSizes() : self
- Set Plot Bubble Sizes.
- setPlotDirection() : $this
- Set Plot Direction.
- setPlotGrouping() : $this
- Set Plot Grouping Type.
- setPlotStyle() : $this
- Set Plot Style.
- setPlotType() : $this
- Set Plot Type.
- setSmoothLine() : $this
- Set Smooth Line.
Constants
DIRECTION_BAR
public
mixed
DIRECTION_BAR
= 'bar'
DIRECTION_COL
public
mixed
DIRECTION_COL
= 'col'
DIRECTION_COLUMN
public
mixed
DIRECTION_COLUMN
= self::DIRECTION_COL
DIRECTION_HORIZONTAL
public
mixed
DIRECTION_HORIZONTAL
= self::DIRECTION_BAR
DIRECTION_VERTICAL
public
mixed
DIRECTION_VERTICAL
= self::DIRECTION_COL
EMPTY_AS_GAP
public
mixed
EMPTY_AS_GAP
= 'gap'
EMPTY_AS_SPAN
public
mixed
EMPTY_AS_SPAN
= 'span'
EMPTY_AS_ZERO
public
mixed
EMPTY_AS_ZERO
= 'zero'
GROUPING_CLUSTERED
public
mixed
GROUPING_CLUSTERED
= 'clustered'
GROUPING_PERCENT_STACKED
public
mixed
GROUPING_PERCENT_STACKED
= 'percentStacked'
GROUPING_STACKED
public
mixed
GROUPING_STACKED
= 'stacked'
GROUPING_STANDARD
public
mixed
GROUPING_STANDARD
= 'standard'
STYLE_FILLED
public
mixed
STYLE_FILLED
= 'filled'
STYLE_LINEMARKER
public
mixed
STYLE_LINEMARKER
= 'lineMarker'
STYLE_MARKER
public
mixed
STYLE_MARKER
= 'marker'
STYLE_SMOOTHMARKER
public
mixed
STYLE_SMOOTHMARKER
= 'smoothMarker'
TYPE_AREACHART
public
mixed
TYPE_AREACHART
= 'areaChart'
TYPE_AREACHART_3D
public
mixed
TYPE_AREACHART_3D
= 'area3DChart'
TYPE_BARCHART
public
mixed
TYPE_BARCHART
= 'barChart'
TYPE_BARCHART_3D
public
mixed
TYPE_BARCHART_3D
= 'bar3DChart'
TYPE_BUBBLECHART
public
mixed
TYPE_BUBBLECHART
= 'bubbleChart'
TYPE_CANDLECHART
public
mixed
TYPE_CANDLECHART
= self::TYPE_STOCKCHART
TYPE_DONUTCHART
public
mixed
TYPE_DONUTCHART
= self::TYPE_DOUGHNUTCHART
TYPE_DOUGHNUTCHART
public
mixed
TYPE_DOUGHNUTCHART
= 'doughnutChart'
TYPE_LINECHART
public
mixed
TYPE_LINECHART
= 'lineChart'
TYPE_LINECHART_3D
public
mixed
TYPE_LINECHART_3D
= 'line3DChart'
TYPE_PIECHART
public
mixed
TYPE_PIECHART
= 'pieChart'
TYPE_PIECHART_3D
public
mixed
TYPE_PIECHART_3D
= 'pie3DChart'
TYPE_RADARCHART
public
mixed
TYPE_RADARCHART
= 'radarChart'
TYPE_SCATTERCHART
public
mixed
TYPE_SCATTERCHART
= 'scatterChart'
TYPE_STOCKCHART
public
mixed
TYPE_STOCKCHART
= 'stockChart'
TYPE_SURFACECHART
public
mixed
TYPE_SURFACECHART
= 'surfaceChart'
TYPE_SURFACECHART_3D
public
mixed
TYPE_SURFACECHART_3D
= 'surface3DChart'
Properties
$plotBubbleSizes
Plot Bubble Sizes.
private
array<string|int, DataSeriesValues>
$plotBubbleSizes
= []
$plotCategory
Plot Category.
private
array<string|int, DataSeriesValues>
$plotCategory
$plotDirection
Plot Direction.
private
string
$plotDirection
$plotGrouping
Plot Grouping Type.
private
string|null
$plotGrouping
$plotLabel
Plot Label.
private
array<string|int, DataSeriesValues>
$plotLabel
$plotOrder
Order of plots in Series.
private
array<string|int, int>
$plotOrder
$plotStyle
Plot Style.
private
string|null
$plotStyle
$plotType
Series Plot Type.
private
string|null
$plotType
$plotValues
Plot Values.
private
array<string|int, DataSeriesValues>
$plotValues
$smoothLine
Smooth Line. Must be specified for both DataSeries and DataSeriesValues.
private
bool
$smoothLine
Methods
__clone()
Implement PHP __clone to create a deep clone, not just a shallow copy.
public
__clone() : mixed
__construct()
Create a new DataSeries.
public
__construct([null|string $plotType = null ][, null|string $plotGrouping = null ][, array<string|int, int> $plotOrder = [] ][, array<string|int, DataSeriesValues> $plotLabel = [] ][, array<string|int, DataSeriesValues> $plotCategory = [] ][, array<string|int, DataSeriesValues> $plotValues = [] ][, string|null $plotDirection = null ][, bool $smoothLine = false ][, string|null $plotStyle = null ]) : mixed
Parameters
- $plotType : null|string = null
- $plotGrouping : null|string = null
- $plotOrder : array<string|int, int> = []
- $plotLabel : array<string|int, DataSeriesValues> = []
- $plotCategory : array<string|int, DataSeriesValues> = []
- $plotValues : array<string|int, DataSeriesValues> = []
- $plotDirection : string|null = null
- $smoothLine : bool = false
- $plotStyle : string|null = null
getPlotBubbleSizes()
Get Plot Bubble Sizes.
public
getPlotBubbleSizes() : array<string|int, DataSeriesValues>
Return values
array<string|int, DataSeriesValues>getPlotCategories()
Get Plot Categories.
public
getPlotCategories() : array<string|int, DataSeriesValues>
Return values
array<string|int, DataSeriesValues>getPlotCategoryByIndex()
Get Plot Category by Index.
public
getPlotCategoryByIndex(int $index) : DataSeriesValues|false
Parameters
- $index : int
Return values
DataSeriesValues|falsegetPlotDirection()
Get Plot Direction.
public
getPlotDirection() : string
Return values
stringgetPlotGrouping()
Get Plot Grouping Type.
public
getPlotGrouping() : string|null
Return values
string|nullgetPlotLabelByIndex()
Get Plot Label by Index.
public
getPlotLabelByIndex(int $index) : DataSeriesValues|false
Parameters
- $index : int
Return values
DataSeriesValues|falsegetPlotLabels()
Get Plot Labels.
public
getPlotLabels() : array<string|int, DataSeriesValues>
Return values
array<string|int, DataSeriesValues>getPlotOrder()
Get Plot Order.
public
getPlotOrder() : array<string|int, int>
Return values
array<string|int, int>getPlotSeriesCount()
Get Number of Plot Series.
public
getPlotSeriesCount() : int
Return values
intgetPlotStyle()
Get Plot Style.
public
getPlotStyle() : string|null
Return values
string|nullgetPlotType()
Get Plot Type.
public
getPlotType() : string|null
Return values
string|nullgetPlotValues()
Get Plot Values.
public
getPlotValues() : array<string|int, DataSeriesValues>
Return values
array<string|int, DataSeriesValues>getPlotValuesByIndex()
Get Plot Values by Index.
public
getPlotValuesByIndex(int $index) : DataSeriesValues|false
Parameters
- $index : int
Return values
DataSeriesValues|falsegetSmoothLine()
Get Smooth Line.
public
getSmoothLine() : bool
Return values
boolrefresh()
public
refresh(Worksheet $worksheet) : void
Parameters
- $worksheet : Worksheet
setPlotBubbleSizes()
Set Plot Bubble Sizes.
public
setPlotBubbleSizes(array<string|int, DataSeriesValues> $plotBubbleSizes) : self
Parameters
- $plotBubbleSizes : array<string|int, DataSeriesValues>
Return values
selfsetPlotDirection()
Set Plot Direction.
public
setPlotDirection(string $plotDirection) : $this
Parameters
- $plotDirection : string
Return values
$thissetPlotGrouping()
Set Plot Grouping Type.
public
setPlotGrouping(string $groupingType) : $this
Parameters
- $groupingType : string
Return values
$thissetPlotStyle()
Set Plot Style.
public
setPlotStyle(string|null $plotStyle) : $this
Parameters
- $plotStyle : string|null
Return values
$thissetPlotType()
Set Plot Type.
public
setPlotType(string $plotType) : $this
Parameters
- $plotType : string
Return values
$thissetSmoothLine()
Set Smooth Line.
public
setSmoothLine(bool $smoothLine) : $this
Parameters
- $smoothLine : bool