Documentation

Series
in package
implements ComparableInterface

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Constants

LABEL_BESTFIT  = 'bestFit'
LABEL_BOTTOM  = 'b'
LABEL_CENTER  = 'ctr'
LABEL_INSIDEBASE  = 'inBase'
LABEL_INSIDEEND  = 'inEnd'
LABEL_LEFT  = 'i'
LABEL_OUTSIDEEND  = 'outEnd'
LABEL_RIGHT  = 'r'
LABEL_TOP  = 't'

Properties

$dataPointFills  : array<int, Fill>
DataPointFills (key/value).
$dlblNumFormat  : string
Data Label Number Format.
$fill  : null|Fill
$font  : null|Font
$labelPosition  : string
$marker  : Marker
$outline  : null|Outline
$separator  : null|string
$hashIndex  : int
Hash index.
$showCategoryName  : bool
Show Category Name.
$showLeaderLines  : bool
Show Leader Lines.
$showLegendKey  : bool
Show Legend Key.
$showPercentage  : bool
ShowPercentage.
$showSeriesName  : bool
ShowSeriesName.
$showValue  : bool
ShowValue.
$title  : string
Title.
$values  : array<string, null|string>
Values (key/value).

Methods

__clone()  : mixed
__construct()  : mixed
addValue()  : self
Add Value.
getDataPointFill()  : Fill
getDataPointFills()  : array<string|int, Fill>
getDlblNumFormat()  : string
Get Data Label NumFormat.
getFill()  : Fill|null
getFont()  : Font|null
Get font.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getLabelPosition()  : string
Get label position.
getMarker()  : Marker
getOutline()  : Outline|null
getSeparator()  : string|null
getTitle()  : string
Get Title.
getValues()  : array<string, null|string>
Get Values.
hasDlblNumFormat()  : bool
Has Data Label NumFormat.
hasShowCategoryName()  : bool
Get ShowCategoryName.
hasShowLeaderLines()  : bool
Get ShowLeaderLines.
hasShowLegendKey()  : bool
Get ShowValue.
hasShowPercentage()  : bool
Get ShowPercentage.
hasShowSeparator()  : bool
hasShowSeriesName()  : bool
Get ShowSeriesName.
hasShowValue()  : bool
Get ShowValue.
setDlblNumFormat()  : self
Set Data Label NumFormat.
setFill()  : self
setFont()  : self
Set font.
setHashIndex()  : $this
Set hash index.
setLabelPosition()  : self
Set label position.
setMarker()  : self
setOutline()  : self
setSeparator()  : self
setShowCategoryName()  : self
Set ShowCategoryName.
setShowLeaderLines()  : self
Set ShowLeaderLines.
setShowLegendKey()  : self
Set ShowValue.
setShowPercentage()  : self
Set ShowPercentage.
setShowSeriesName()  : self
Set ShowSeriesName.
setShowValue()  : self
Set ShowValue.
setTitle()  : self
Set Title.
setValues()  : self
Set Values.

Constants

LABEL_BESTFIT

public mixed LABEL_BESTFIT = 'bestFit'

LABEL_BOTTOM

public mixed LABEL_BOTTOM = 'b'

LABEL_CENTER

public mixed LABEL_CENTER = 'ctr'

LABEL_INSIDEBASE

public mixed LABEL_INSIDEBASE = 'inBase'

LABEL_INSIDEEND

public mixed LABEL_INSIDEEND = 'inEnd'

LABEL_LEFT

public mixed LABEL_LEFT = 'i'

LABEL_OUTSIDEEND

public mixed LABEL_OUTSIDEEND = 'outEnd'

LABEL_RIGHT

public mixed LABEL_RIGHT = 'r'

LABEL_TOP

public mixed LABEL_TOP = 't'

Properties

$dataPointFills

DataPointFills (key/value).

protected array<int, Fill> $dataPointFills = []

$dlblNumFormat

Data Label Number Format.

protected string $dlblNumFormat = ''

$labelPosition

protected string $labelPosition = 'ctr'

$separator

protected null|string $separator

$hashIndex

Hash index.

private int $hashIndex

$showCategoryName

Show Category Name.

private bool $showCategoryName = false

$showLeaderLines

Show Leader Lines.

private bool $showLeaderLines = true

$showLegendKey

Show Legend Key.

private bool $showLegendKey = false

$showPercentage

ShowPercentage.

private bool $showPercentage = false

$showSeriesName

ShowSeriesName.

private bool $showSeriesName = false

$showValue

ShowValue.

private bool $showValue = true

$title

Title.

private string $title = 'Series Title'

$values

Values (key/value).

private array<string, null|string> $values = []

Methods

__construct()

public __construct([string $title = 'Series Title' ][, array<string, null|string> $values = [] ]) : mixed
Parameters
$title : string = 'Series Title'
$values : array<string, null|string> = []

addValue()

Add Value.

public addValue(string $key, string|null $value) : self
Parameters
$key : string
$value : string|null
Return values
self

getDataPointFill()

public getDataPointFill(int $dataPointIndex) : Fill
Parameters
$dataPointIndex : int

data point index

Return values
Fill

getDataPointFills()

public getDataPointFills() : array<string|int, Fill>
Return values
array<string|int, Fill>

getDlblNumFormat()

Get Data Label NumFormat.

public getDlblNumFormat() : string
Return values
string

getFont()

Get font.

public getFont() : Font|null
Return values
Font|null

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string —

Hash code

getHashIndex()

Get hash index.

public getHashIndex() : null|int

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.

Return values
null|int —

Hash index

getLabelPosition()

Get label position.

public getLabelPosition() : string
Return values
string

getSeparator()

public getSeparator() : string|null
Return values
string|null

getTitle()

Get Title.

public getTitle() : string
Return values
string

getValues()

Get Values.

public getValues() : array<string, null|string>
Return values
array<string, null|string>

hasDlblNumFormat()

Has Data Label NumFormat.

public hasDlblNumFormat() : bool
Return values
bool

hasShowCategoryName()

Get ShowCategoryName.

public hasShowCategoryName() : bool
Return values
bool

hasShowLeaderLines()

Get ShowLeaderLines.

public hasShowLeaderLines() : bool
Return values
bool

hasShowLegendKey()

Get ShowValue.

public hasShowLegendKey() : bool
Return values
bool

hasShowPercentage()

Get ShowPercentage.

public hasShowPercentage() : bool
Return values
bool

hasShowSeparator()

public hasShowSeparator() : bool
Return values
bool

hasShowSeriesName()

Get ShowSeriesName.

public hasShowSeriesName() : bool
Return values
bool

hasShowValue()

Get ShowValue.

public hasShowValue() : bool
Return values
bool

setDlblNumFormat()

Set Data Label NumFormat.

public setDlblNumFormat([string $value = '' ]) : self
Parameters
$value : string = ''
Return values
self

setFill()

public setFill([Fill|null $fill = null ]) : self
Parameters
$fill : Fill|null = null
Return values
self

setFont()

Set font.

public setFont([null|Font $pFont = null ]) : self
Parameters
$pFont : null|Font = null

Font

Return values
self

setHashIndex()

Set hash index.

public setHashIndex(int $value) : $this

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.

Parameters
$value : int

Hash index

Return values
$this

setLabelPosition()

Set label position.

public setLabelPosition(string $value) : self
Parameters
$value : string
Return values
self

setMarker()

public setMarker(Marker $marker) : self
Parameters
$marker : Marker
Return values
self

setOutline()

public setOutline(Outline|null $outline) : self
Parameters
$outline : Outline|null
Return values
self

setSeparator()

public setSeparator(string|null $pValue) : self
Parameters
$pValue : string|null
Return values
self

setShowCategoryName()

Set ShowCategoryName.

public setShowCategoryName(bool $value) : self
Parameters
$value : bool
Return values
self

setShowLeaderLines()

Set ShowLeaderLines.

public setShowLeaderLines(bool $value) : self
Parameters
$value : bool
Return values
self

setShowLegendKey()

Set ShowValue.

public setShowLegendKey(bool $value) : self
Parameters
$value : bool
Return values
self

setShowPercentage()

Set ShowPercentage.

public setShowPercentage(bool $value) : self
Parameters
$value : bool
Return values
self

setShowSeriesName()

Set ShowSeriesName.

public setShowSeriesName(bool $value) : self
Parameters
$value : bool
Return values
self

setShowValue()

Set ShowValue.

public setShowValue(bool $value) : self
Parameters
$value : bool
Return values
self

setTitle()

Set Title.

public setTitle([string $value = 'Series Title' ]) : self
Parameters
$value : string = 'Series Title'
Return values
self

setValues()

Set Values.

public setValues([array<string, null|string> $values = [] ]) : self
Parameters
$values : array<string, null|string> = []
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results