Documentation

Slide extends AbstractSlide
in package
implements ComparableInterface, ShapeContainerInterface

Slide class.

Table of Contents

Interfaces

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

Properties

$animations  : array<string|int, Animation>
$background  : AbstractBackground
Background of the slide.
$extentX  : int
Extent X.
$extentY  : int
Extent Y.
$hashIndex  : int
Hash index.
$identifier  : string
Slide identifier.
$isVisible  : bool
The slide is shown in presentation.
$name  : null|string
Name of the title.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$parent  : null|PhpPresentation
Parent presentation.
$relsIndex  : string
$shapeCollection  : array<int, AbstractShape>
Collection of shapes.
$slideTransition  : null|Transition
$slideLayout  : null|SlideLayout
Slide layout.
$slideMasterId  : int
Slide master id.
$slideNote  : Note

Methods

__clone()  : mixed
__construct()  : mixed
Create a new slide.
addAnimation()  : Slide
Add an animation to the slide.
addShape()  : static
copy()  : Slide
Copy slide (!= clone!).
createChartShape()  : Chart
Create chart shape.
createDrawingShape()  : File
Create drawing shape.
createGroup()  : Group
Creates a group within this slide.
createLineShape()  : Line
Create line shape.
createRichTextShape()  : RichText
Create rich text shape.
createTableShape()  : Table
Create table shape.
getAnimations()  : array<string|int, Animation>
Get collection of animations.
getBackground()  : AbstractBackground|null
getExtentX()  : int
Get X Extent.
getExtentY()  : int
Get Y Extent.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getName()  : string|null
Get the name of the slide.
getNote()  : Note
getOffsetX()  : int
Get X Offset.
getOffsetY()  : int
Get Y Offset.
getParent()  : PhpPresentation|null
Get parent.
getRelsIndex()  : string
getShapeCollection()  : array<int, AbstractShape>
Get collection of shapes.
getSlideLayout()  : SlideLayout|null
Get slide layout.
getSlideMasterId()  : int
Get slide master id.
getTransition()  : Transition|null
isVisible()  : bool
rebindParent()  : self
Re-bind parent.
searchShapes()  : array<int, AbstractShape>
Search into collection of shapes for a name or/and a type.
setAnimations()  : Slide
Set collection of animations.
setBackground()  : self
setHashIndex()  : $this
Set hash index.
setIsVisible()  : Slide
setName()  : self
Set the name of the slide.
setNote()  : self
setRelsIndex()  : self
setShapeCollection()  : self
Get collection of shapes.
setSlideLayout()  : self
Set slide layout.
setSlideMasterId()  : Slide
Set slide master id.
setTransition()  : self
unsetShape()  : static

Properties

$isVisible

The slide is shown in presentation.

protected bool $isVisible = true

$name

Name of the title.

protected null|string $name

$slideMasterId

Slide master id.

private int $slideMasterId = 1

Methods

__clone()

public __clone() : mixed

createLineShape()

Create line shape.

public createLineShape(int $fromX, int $fromY, int $toX, int $toY) : Line
Parameters
$fromX : int

Starting point x offset

$fromY : int

Starting point y offset

$toX : int

Ending point x offset

$toY : int

Ending point y offset

Return values
Line

createTableShape()

Create table shape.

public createTableShape([int $columns = 1 ]) : Table
Parameters
$columns : int = 1

Number of columns

Return values
Table

getAnimations()

Get collection of animations.

public getAnimations() : array<string|int, Animation>
Return values
array<string|int, Animation>

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

getName()

Get the name of the slide.

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

getOffsetX()

Get X Offset.

public getOffsetX() : int
Return values
int

getOffsetY()

Get Y Offset.

public getOffsetY() : int
Return values
int

getRelsIndex()

public getRelsIndex() : string
Return values
string

getSlideMasterId()

Get slide master id.

public getSlideMasterId() : int
Return values
int

isVisible()

public isVisible() : bool
Return values
bool

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>

setAnimations()

Set collection of animations.

public setAnimations([array<string|int, Animation> $array = [] ]) : Slide
Parameters
$array : array<string|int, Animation> = []
Return values
Slide

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

setIsVisible()

public setIsVisible([bool $value = true ]) : Slide
Parameters
$value : bool = true
Return values
Slide

setName()

Set the name of the slide.

public setName([string|null $name = null ]) : self
Parameters
$name : string|null = null
Return values
self

setNote()

public setNote([Note|null $note = null ]) : self
Parameters
$note : Note|null = null
Return values
self

setRelsIndex()

public setRelsIndex(string $indexName) : self
Parameters
$indexName : string
Return values
self

setShapeCollection()

Get collection of shapes.

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

setSlideLayout()

Set slide layout.

public setSlideLayout(SlideLayout $layout) : self
Parameters
$layout : SlideLayout
Return values
self

setSlideMasterId()

Set slide master id.

public setSlideMasterId([int $masterId = 1 ]) : Slide
Parameters
$masterId : int = 1
Return values
Slide

unsetShape()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results