Documentation

PlotArea
in package
implements ComparableInterface

\PhpOffice\PhpPresentation\Shape\Chart\PlotArea.

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Properties

$axisX  : Axis
Axis X.
$axisY  : Axis
Axis Y.
$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).
$type  : null|AbstractType
Type.
$width  : float
Width (as a fraction of the chart).

Methods

__clone()  : mixed
__construct()  : mixed
getAxisX()  : Axis
Get Axis X.
getAxisY()  : Axis
Get Axis Y.
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).
getType()  : AbstractType
getWidth()  : float
Get Width (as a fraction of the chart).
setHashIndex()  : PlotArea
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).
setType()  : self
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

$offsetY

OffsetY (as a fraction of the chart).

private float $offsetY = 0

$width

Width (as a fraction of the chart).

private float $width = 0

Methods

__construct()

public __construct() : mixed

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

getWidth()

Get Width (as a fraction of the chart).

public getWidth() : float
Return values
float

setHashIndex()

Set hash index.

public setHashIndex(int $value) : PlotArea

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
PlotArea

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 $pValue = 0 ]) : self
Parameters
$pValue : float = 0
Return values
self

setOffsetY()

Set OffsetY (as a fraction of the chart).

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

setWidth()

Set Width (as a fraction of the chart).

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

        
On this page

Search results