PHP Class PhpOffice\PhpPresentation\Shape\Chart\Series

Inheritance: implements PhpOffice\PhpPresentation\ComparableInterface

Show file Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Property	Type	Description
$marker	Marker
$outline	PhpOffice\PhpPresentation\Style\Outline

Public Methods

Method	Description
__clone ( ) : mixed
__construct ( string $title = 'Series Title', array $values = [] )	Create a new \PhpOffice\PhpPresentation\Shape\Chart\Series instance
addValue ( mixed $key, mixed $value ) : Series	Add Value
getDataPointFill ( integer $dataPointIndex ) : PhpOffice\PhpPresentation\Style\Fill	Get DataPointFill
getDataPointFills ( ) : PhpOffice\PhpPresentation\Style\Fill[]	Get DataPointFills
getDlblNumFormat ( ) : string	Get Data Label NumFormat
getFill ( ) : PhpOffice\PhpPresentation\Style\Fill	Get Fill
getFont ( ) : Font	Get font
getHashCode ( ) : string	Get hash code
getHashIndex ( ) : string	Get hash index
getLabelPosition ( ) : string	Get label position
getMarker ( ) : Marker
getOutline ( ) : Outline
getTitle ( ) : string	Get Title
getValues ( ) : array	Get Values
hasDlblNumFormat ( ) : string	Has Data Label NumFormat
hasShowCategoryName ( ) : boolean	Get ShowCategoryName
hasShowLeaderLines ( ) : boolean	Get ShowLeaderLines
hasShowPercentage ( ) : boolean	Get ShowPercentage
hasShowSeriesName ( ) : boolean	Get ShowSeriesName
hasShowValue ( ) : boolean	Get ShowValue
setDlblNumFormat ( string $value = '' ) : Series	Set Data Label NumFormat
setFill ( PhpOffice\PhpPresentation\Style\Fill $fill = null ) : Series	Set Fill
setFont ( Font $pFont = null ) : Paragraph	Set font
setHashIndex ( string $value ) : Series	Set hash index
setLabelPosition ( string $value ) : Series	Set label position
setMarker ( Marker $marker ) : Series
setOutline ( Outline $outline ) : Series
setShowCategoryName ( boolean $value ) : Series	Set ShowCategoryName
setShowLeaderLines ( boolean $value ) : Series	Set ShowLeaderLines
setShowPercentage ( boolean $value ) : Series	Set ShowPercentage
setShowSeriesName ( boolean $value ) : Series	Set ShowSeriesName
setShowValue ( boolean $value ) : Series	Set ShowValue
setTitle ( string $value = 'Series Title' ) : Series	Set Title
setValues ( array $value = [] ) : Series	Set Values

Method Details

__clone() public method

See link: http://php.net/manual/en/language.oop5.cloning.php

public __clone ( ) : mixed
return	mixed

__construct() public method

Create a new \PhpOffice\PhpPresentation\Shape\Chart\Series instance

public __construct ( string $title = 'Series Title', array $values = [] )
$title	string	Title
$values	array	Values

addValue() public method

Add Value

public addValue ( mixed $key, mixed $value ) : Series
$key	mixed
$value	mixed
return	Series

getDataPointFill() public method

Get DataPointFill

public getDataPointFill ( integer $dataPointIndex ) : PhpOffice\PhpPresentation\Style\Fill
$dataPointIndex	integer	Data point index.
return	PhpOffice\PhpPresentation\Style\Fill

getDataPointFills() public method

Get DataPointFills

public getDataPointFills ( ) : PhpOffice\PhpPresentation\Style\Fill[]
return	PhpOffice\PhpPresentation\Style\Fill[]

getDlblNumFormat() public method

Get Data Label NumFormat

public getDlblNumFormat ( ) : string
return	string

getFill() public method

Get Fill

public getFill ( ) : PhpOffice\PhpPresentation\Style\Fill
return	PhpOffice\PhpPresentation\Style\Fill

getFont() public method

Get font

public getFont ( ) : Font
return	PhpOffice\PhpPresentation\Style\Font

getHashCode() public method

Get hash code

public getHashCode ( ) : string
return	string	Hash code

getHashIndex() public method

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

public getHashIndex ( ) : string
return	string	Hash index

getLabelPosition() public method

Get label position

public getLabelPosition ( ) : string
return	string

getMarker() public method

public getMarker ( ) : Marker
return	Marker

getOutline() public method

public getOutline ( ) : Outline
return	PhpOffice\PhpPresentation\Style\Outline

getTitle() public method

Get Title

public getTitle ( ) : string
return	string

getValues() public method

Get Values

public getValues ( ) : array
return	array

hasDlblNumFormat() public method

Has Data Label NumFormat

public hasDlblNumFormat ( ) : string
return	string

hasShowCategoryName() public method

Get ShowCategoryName

public hasShowCategoryName ( ) : boolean
return	boolean

hasShowLeaderLines() public method

Get ShowLeaderLines

public hasShowLeaderLines ( ) : boolean
return	boolean

hasShowPercentage() public method

Get ShowPercentage

public hasShowPercentage ( ) : boolean
return	boolean

hasShowSeriesName() public method

Get ShowSeriesName

public hasShowSeriesName ( ) : boolean
return	boolean

hasShowValue() public method

Get ShowValue

public hasShowValue ( ) : boolean
return	boolean

setDlblNumFormat() public method

Set Data Label NumFormat

public setDlblNumFormat ( string $value = '' ) : Series
$value	string
return	Series

setFill() public method

Set Fill

public setFill ( PhpOffice\PhpPresentation\Style\Fill $fill = null ) : Series
$fill	PhpOffice\PhpPresentation\Style\Fill
return	Series

setFont() public method

Set font

public setFont ( Font $pFont = null ) : Paragraph
$pFont	PhpOffice\PhpPresentation\Style\Font	Font
return	PhpOffice\PhpPresentation\Shape\RichText\Paragraph

setHashIndex() public method

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

public setHashIndex ( string $value ) : Series
$value	string	Hash index
return	Series

setLabelPosition() public method

Set label position

public setLabelPosition ( string $value ) : Series
$value	string
return	Series

setMarker() public method

public setMarker ( Marker $marker ) : Series
$marker	Marker
return	Series

setOutline() public method

public setOutline ( Outline $outline ) : Series
$outline	PhpOffice\PhpPresentation\Style\Outline
return	Series

setShowCategoryName() public method

Set ShowCategoryName

public setShowCategoryName ( boolean $value ) : Series
$value	boolean
return	Series

setShowLeaderLines() public method

Set ShowLeaderLines

public setShowLeaderLines ( boolean $value ) : Series
$value	boolean
return	Series

setShowPercentage() public method

Set ShowPercentage

public setShowPercentage ( boolean $value ) : Series
$value	boolean
return	Series

setShowSeriesName() public method

Set ShowSeriesName

public setShowSeriesName ( boolean $value ) : Series
$value	boolean
return	Series

setShowValue() public method

Set ShowValue

public setShowValue ( boolean $value ) : Series
$value	boolean
return	Series

setTitle() public method

Set Title

public setTitle ( string $value = 'Series Title' ) : Series
$value	string
return	Series

setValues() public method

Set Values

public setValues ( array $value = [] ) : Series
$value	array
return	Series

Property Details

$marker protected property

protected Marker,PhpOffice\PhpPresentation\Shape\Chart $marker
return	Marker

$outline protected property

protected Outline,PhpOffice\PhpPresentation\Style $outline
return	PhpOffice\PhpPresentation\Style\Outline