Documentation

SlideLayout extends AbstractSlide
in package
implements ComparableInterface, ShapeContainerInterface

Table of Contents

Interfaces

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

Properties

$colorMap  : ColorMap
Mapping of colors to the theme.
$layoutId  : int
Slide layout ID (should not be used by user code!).
$layoutNr  : int
Slide layout NR (should not be used by user code!).
$relationId  : string
Slide relation ID (should not be used by user code!).
$background  : AbstractBackground
Background of the slide.
$extentX  : int
Extent X.
$extentY  : int
Extent Y.
$hashIndex  : int
Hash index.
$identifier  : string
Slide identifier.
$layoutName  : null|string
Slide layout ID (should not be used by user code!).
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$parent  : null|PhpPresentation
Parent presentation.
$relsIndex  : string
$shapeCollection  : array<int, AbstractShape>
Collection of shapes.
$slideMaster  : SlideMaster
$slideTransition  : null|Transition

Methods

__construct()  : mixed
Create a new slideLayout.
addShape()  : static
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.
getBackground()  : AbstractBackground|null
getExtentX()  : int
Get X Extent.
getExtentY()  : int
Get Y Extent.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getLayoutName()  : string|null
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.
getSlideMaster()  : SlideMaster
getTransition()  : Transition|null
rebindParent()  : self
Re-bind parent.
searchShapes()  : array<int, AbstractShape>
Search into collection of shapes for a name or/and a type.
setBackground()  : self
setHashIndex()  : $this
Set hash index.
setLayoutName()  : self
setRelsIndex()  : self
setShapeCollection()  : self
Get collection of shapes.
setTransition()  : self
unsetShape()  : static

Properties

$layoutId

Slide layout ID (should not be used by user code!).

public int $layoutId

$layoutNr

Slide layout NR (should not be used by user code!).

public int $layoutNr

$relationId

Slide relation ID (should not be used by user code!).

public string $relationId

$layoutName

Slide layout ID (should not be used by user code!).

protected null|string $layoutName

Methods

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

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

getLayoutName()

public getLayoutName() : 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

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

setLayoutName()

public setLayoutName(string $layoutName) : self
Parameters
$layoutName : string
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

unsetShape()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results