class DataSeriesValues (View source)

Constants

DATASERIES_TYPE_STRING

DATASERIES_TYPE_NUMBER

Methods

__construct(string $dataType = self::DATASERIES_TYPE_NUMBER, string $dataSource = null, null|mixed $formatCode = null, int $pointCount = 0, mixed $dataValues = [], null|mixed $marker = null, null|string|string[] $fillColor = null)

Create a new DataSeriesValues object.

string
getDataType()

Get Series Data Type.

setDataType(string $dataType)

Set Series Data Type.

string
getDataSource()

Get Series Data Source (formula).

setDataSource(string $dataSource)

Set Series Data Source (formula).

string
getPointMarker()

Get Point Marker.

setPointMarker(string $marker)

Set Point Marker.

string
getFormatCode()

Get Series Format Code.

setFormatCode(string $formatCode)

Set Series Format Code.

int
getPointCount()

Get Series Point Count.

string|string[]
getFillColor()

Get fill color.

setFillColor(string|string[] $color)

Set fill color for series.

int
getLineWidth()

Get line width for series.

setLineWidth(int $width)

Set line width for the series.

null|bool
isMultiLevelSeries()

Identify if the Data Series is a multi-level or a simple series.

int
multiLevelCount()

Return the level count of a multi-level Data Series.

array
getDataValues()

Get Series Data Values.

mixed
getDataValue()

Get the first Series Data value.

setDataValues(array $dataValues)

Set Series Data Values.

refresh(Worksheet $worksheet, $flatten = true)

No description

Details

__construct(string $dataType = self::DATASERIES_TYPE_NUMBER, string $dataSource = null, null|mixed $formatCode = null, int $pointCount = 0, mixed $dataValues = [], null|mixed $marker = null, null|string|string[] $fillColor = null)

Create a new DataSeriesValues object.

Parameters

string $dataType
string $dataSource
null|mixed $formatCode
int $pointCount
mixed $dataValues
null|mixed $marker
null|string|string[] $fillColor

string getDataType()

Get Series Data Type.

Return Value

string

DataSeriesValues setDataType(string $dataType)

Set Series Data Type.

Parameters

string $dataType Datatype of this data series Typical values are: DataSeriesValues::DATASERIES_TYPE_STRING Normally used for axis point values DataSeriesValues::DATASERIES_TYPE_NUMBER Normally used for chart data values

Return Value

DataSeriesValues

Exceptions

Exception

string getDataSource()

Get Series Data Source (formula).

Return Value

string

DataSeriesValues setDataSource(string $dataSource)

Set Series Data Source (formula).

Parameters

string $dataSource

Return Value

DataSeriesValues

string getPointMarker()

Get Point Marker.

Return Value

string

DataSeriesValues setPointMarker(string $marker)

Set Point Marker.

Parameters

string $marker

Return Value

DataSeriesValues

string getFormatCode()

Get Series Format Code.

Return Value

string

DataSeriesValues setFormatCode(string $formatCode)

Set Series Format Code.

Parameters

string $formatCode

Return Value

DataSeriesValues

int getPointCount()

Get Series Point Count.

Return Value

int

string|string[] getFillColor()

Get fill color.

Return Value

string|string[] HEX color or array with HEX colors

DataSeriesValues setFillColor(string|string[] $color)

Set fill color for series.

Parameters

string|string[] $color HEX color or array with HEX colors

Return Value

DataSeriesValues

int getLineWidth()

Get line width for series.

Return Value

int

DataSeriesValues setLineWidth(int $width)

Set line width for the series.

Parameters

int $width

Return Value

DataSeriesValues

null|bool isMultiLevelSeries()

Identify if the Data Series is a multi-level or a simple series.

Return Value

null|bool

int multiLevelCount()

Return the level count of a multi-level Data Series.

Return Value

int

array getDataValues()

Get Series Data Values.

Return Value

array of mixed

mixed getDataValue()

Get the first Series Data value.

Return Value

mixed

DataSeriesValues setDataValues(array $dataValues)

Set Series Data Values.

Parameters

array $dataValues

Return Value

DataSeriesValues

refresh(Worksheet $worksheet, $flatten = true)

Parameters

Worksheet $worksheet
$flatten