Documentation

Title
in package
implements ComparableInterface

\PhpOffice\PhpPresentation\Shape\Chart\Title.

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Properties

$alignment  : Alignment
Alignment.
$font  : Font
Font.
$hashIndex  : int
Hash index.
$height  : float
Height (as a fraction of the chart).
$offsetX  : float
OffsetX (as a fraction of the chart).
$offsetY  : float
OffsetY (as a fraction of the chart).
$text  : string
Text.
$visible  : bool
Visible.
$width  : float
Width (as a fraction of the chart).

Methods

__construct()  : mixed
Create a new \PhpOffice\PhpPresentation\Shape\Chart\Title instance.
getAlignment()  : Alignment
Get alignment.
getFont()  : Font|null
Get font.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHeight()  : float
Get Height (as a fraction of the chart).
getOffsetX()  : float
Get OffsetX (as a fraction of the chart).
getOffsetY()  : float
Get OffsetY (as a fraction of the chart).
getText()  : string
Get Text.
getWidth()  : float
Get Width (as a fraction of the chart).
isVisible()  : bool
Get Visible.
setAlignment()  : Title
Set alignment.
setFont()  : self
Set font.
setHashIndex()  : Title
Set hash index.
setHeight()  : self
Set Height (as a fraction of the chart).
setOffsetX()  : self
Set OffsetX (as a fraction of the chart).
setOffsetY()  : self
Set OffsetY (as a fraction of the chart).
setText()  : Title
Set Text.
setVisible()  : Title
Set Visible.
setWidth()  : self
Set Width (as a fraction of the chart).

Properties

$hashIndex

Hash index.

private int $hashIndex

$height

Height (as a fraction of the chart).

private float $height = 0

$offsetX

OffsetX (as a fraction of the chart).

private float $offsetX = 0.01

$offsetY

OffsetY (as a fraction of the chart).

private float $offsetY = 0.01

$text

Text.

private string $text = 'Chart Title'

$visible

Visible.

private bool $visible = true

$width

Width (as a fraction of the chart).

private float $width = 0

Methods

__construct()

Create a new \PhpOffice\PhpPresentation\Shape\Chart\Title instance.

public __construct() : mixed

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

getHeight()

Get Height (as a fraction of the chart).

public getHeight() : float
Return values
float

getOffsetX()

Get OffsetX (as a fraction of the chart).

public getOffsetX() : float
Return values
float

getOffsetY()

Get OffsetY (as a fraction of the chart).

public getOffsetY() : float
Return values
float

getText()

Get Text.

public getText() : string
Return values
string

getWidth()

Get Width (as a fraction of the chart).

public getWidth() : float
Return values
float

isVisible()

Get Visible.

public isVisible() : bool
Return values
bool

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) : Title

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
Title

setHeight()

Set Height (as a fraction of the chart).

public setHeight([float $value = 0 ]) : self
Parameters
$value : float = 0
Return values
self

setOffsetX()

Set OffsetX (as a fraction of the chart).

public setOffsetX([float $value = 0.01 ]) : self
Parameters
$value : float = 0.01
Return values
self

setOffsetY()

Set OffsetY (as a fraction of the chart).

public setOffsetY([float $pValue = 0.01 ]) : self
Parameters
$pValue : float = 0.01
Return values
self

setText()

Set Text.

public setText([string $value = null ]) : Title
Parameters
$value : string = null
Return values
Title

setVisible()

Set Visible.

public setVisible([bool $value = true ]) : Title
Parameters
$value : bool = true
Return values
Title

setWidth()

Set Width (as a fraction of the chart).

public setWidth([float $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results