Documentation

Note
in package
implements ComparableInterface, ShapeContainerInterface uses ShapeCollection

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.
ShapeContainerInterface
PhpOffice\PhpPresentation\ShapeContainerInterface.

Properties

$extentX  : int
Extent X.
$extentY  : int
Extent Y.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$shapeCollection  : array<int, AbstractShape>
Collection of shapes.
$hashIndex  : int
Hash index.
$identifier  : string
Note identifier.
$parent  : Slide
Parent slide.

Methods

__construct()  : mixed
Create a new note.
addShape()  : static
createRichTextShape()  : RichText
Create rich text shape.
getExtentX()  : int
Get X Extent.
getExtentY()  : int
Get Y Extent.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getOffsetX()  : int
Get X Offset.
getOffsetY()  : int
Get Y Offset.
getParent()  : Slide
Get parent.
getShapeCollection()  : array<int, AbstractShape>
Get collection of shapes.
searchShapes()  : array<int, AbstractShape>
Search into collection of shapes for a name or/and a type.
setHashIndex()  : $this
Set hash index.
setParent()  : Note
Set parent.
setShapeCollection()  : self
Get collection of shapes.
unsetShape()  : static

Properties

$extentX

Extent X.

protected int $extentX

$extentY

Extent Y.

protected int $extentY

$offsetX

Offset X.

protected int $offsetX

$offsetY

Offset Y.

protected int $offsetY

$hashIndex

Hash index.

private int $hashIndex

$identifier

Note identifier.

private string $identifier

Methods

__construct()

Create a new note.

public __construct([Slide|null $pParent = null ]) : mixed
Parameters
$pParent : Slide|null = null

createRichTextShape()

Create rich text shape.

public createRichTextShape() : RichText
Return values
RichText

getExtentX()

Get X Extent.

public getExtentX() : int
Return values
int

getExtentY()

Get Y Extent.

public getExtentY() : int
Return values
int

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

getOffsetX()

Get X Offset.

public getOffsetX() : int
Return values
int

getOffsetY()

Get Y Offset.

public getOffsetY() : int
Return values
int

searchShapes()

Search into collection of shapes for a name or/and a type.

public searchShapes([string|null $name = null ][, string|null $type = null ]) : array<int, AbstractShape>
Parameters
$name : string|null = null
$type : string|null = null
Return values
array<int, AbstractShape>

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

setShapeCollection()

Get collection of shapes.

public setShapeCollection([array<int, AbstractShape$shapeCollection = [] ]) : self
Parameters
$shapeCollection : array<int, AbstractShape> = []
Return values
self

unsetShape()

public unsetShape(int $key) : static
Parameters
$key : int
Return values
static

        
On this page

Search results