Documentation

DataSeries

Table of Contents

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'
$plotBubbleSizes  : array<string|int, DataSeriesValues>
Plot Bubble Sizes.
$plotCategory  : array<string|int, DataSeriesValues>
Plot Category.
$plotDirection  : string
Plot Direction.
$plotGrouping  : string
Plot Grouping Type.
$plotLabel  : array<string|int, DataSeriesValues>
Plot Label.
$plotOrder  : array<string|int, int>
Order of plots in Series.
$plotStyle  : null|string
Plot Style.
$plotType  : string
Series Plot Type.
$plotValues  : array<string|int, DataSeriesValues>
Plot Values.
$smoothLine  : bool
Smooth Line. Must be specified for both DataSeries and DataSeriesValues.
__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
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()  : null|string
Get Plot Style.
getPlotType()  : string
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_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

$plotDirection

Plot Direction.

private string $plotDirection

$plotGrouping

Plot Grouping Type.

private string $plotGrouping

$plotOrder

Order of plots in Series.

private array<string|int, int> $plotOrder = []

$plotStyle

Plot Style.

private null|string $plotStyle

$plotType

Series Plot Type.

private string $plotType

$smoothLine

Smooth Line. Must be specified for both DataSeries and DataSeriesValues.

private bool $smoothLine

Methods

__construct()

Create a new DataSeries.

public __construct([null|mixed $plotType = null ][, null|mixed $plotGrouping = null ][, array<string|int, int> $plotOrder = [] ][, array<string|int, DataSeriesValues> $plotLabel = [] ][, array<string|int, DataSeriesValues> $plotCategory = [] ][, array<string|int, DataSeriesValues> $plotValues = [] ][, null|string $plotDirection = null ][, bool $smoothLine = false ][, null|string $plotStyle = null ]) : mixed
Parameters
$plotType : null|mixed = null
$plotGrouping : null|mixed = null
$plotOrder : array<string|int, int> = []
$plotLabel : array<string|int, DataSeriesValues> = []
$plotCategory : array<string|int, DataSeriesValues> = []
$plotValues : array<string|int, DataSeriesValues> = []
$plotDirection : null|string = null
$smoothLine : bool = false
$plotStyle : null|string = null
Return values
mixed —

getPlotDirection()

Get Plot Direction.

public getPlotDirection() : string
Return values
string —

getPlotGrouping()

Get Plot Grouping Type.

public getPlotGrouping() : string
Return values
string —

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
int —

getPlotStyle()

Get Plot Style.

public getPlotStyle() : null|string
Return values
null|string —

getPlotType()

Get Plot Type.

public getPlotType() : string
Return values
string —

getSmoothLine()

Get Smooth Line.

public getSmoothLine() : bool
Return values
bool —

setPlotBubbleSizes()

Set Plot Bubble Sizes.

public setPlotBubbleSizes(array<string|int, DataSeriesValues> $plotBubbleSizes) : self
Parameters
$plotBubbleSizes : array<string|int, DataSeriesValues>
Return values
self —

setPlotDirection()

Set Plot Direction.

public setPlotDirection(string $plotDirection) : $this
Parameters
$plotDirection : string
Return values
$this —

setPlotGrouping()

Set Plot Grouping Type.

public setPlotGrouping(string $groupingType) : $this
Parameters
$groupingType : string
Return values
$this —

setPlotStyle()

Set Plot Style.

public setPlotStyle(null|string $plotStyle) : $this
Parameters
$plotStyle : null|string
Return values
$this —

setPlotType()

Set Plot Type.

public setPlotType(string $plotType) : $this
Parameters
$plotType : string
Return values
$this —

setSmoothLine()

Set Smooth Line.

public setSmoothLine(bool $smoothLine) : $this
Parameters
$smoothLine : bool
Return values
$this —

Search results