Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

(no description)

File Size: 397 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

DataSeriesValues:: (21 methods):
  __construct()
  getDataType()
  setDataType()
  getDataSource()
  setDataSource()
  getPointMarker()
  setPointMarker()
  getFormatCode()
  setFormatCode()
  getPointCount()
  getFillColor()
  setFillColor()
  validateColor()
  getLineWidth()
  setLineWidth()
  isMultiLevelSeries()
  multiLevelCount()
  getDataValues()
  getDataValue()
  setDataValues()
  refresh()


Class: DataSeriesValues  - X-Ref

__construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null, $fillColor = null)   X-Ref
Create a new DataSeriesValues object.

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

getDataType()   X-Ref
Get Series Data Type.

return: string

setDataType($dataType)   X-Ref
Set Series Data Type.

param: string $dataType Datatype of this data series
return: $this

getDataSource()   X-Ref
Get Series Data Source (formula).

return: string

setDataSource($dataSource)   X-Ref
Set Series Data Source (formula).

param: string $dataSource
return: $this

getPointMarker()   X-Ref
Get Point Marker.

return: string

setPointMarker($marker)   X-Ref
Set Point Marker.

param: string $marker
return: $this

getFormatCode()   X-Ref
Get Series Format Code.

return: string

setFormatCode($formatCode)   X-Ref
Set Series Format Code.

param: string $formatCode
return: $this

getPointCount()   X-Ref
Get Series Point Count.

return: int

getFillColor()   X-Ref
Get fill color.

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

setFillColor($color)   X-Ref
Set fill color for series.

param: string|string[] $color HEX color or array with HEX colors
return: DataSeriesValues

validateColor($color)   X-Ref
Method for validating hex color.

param: string $color value for color
return: bool true if validation was successful

getLineWidth()   X-Ref
Get line width for series.

return: int

setLineWidth($width)   X-Ref
Set line width for the series.

param: int $width
return: $this

isMultiLevelSeries()   X-Ref
Identify if the Data Series is a multi-level or a simple series.

return: null|bool

multiLevelCount()   X-Ref
Return the level count of a multi-level Data Series.

return: int

getDataValues()   X-Ref
Get Series Data Values.

return: array of mixed

getDataValue()   X-Ref
Get the first Series Data value.

return: mixed

setDataValues($dataValues)   X-Ref
Set Series Data Values.

param: array $dataValues
return: $this

refresh(Worksheet $worksheet, $flatten = true)   X-Ref
No description