Documentation

Group extends AbstractShape
in package
implements ShapeContainerInterface uses ShapeCollection

Abstract shape.

Table of Contents

Interfaces

ShapeContainerInterface
PhpOffice\PhpPresentation\ShapeContainerInterface.

Properties

$container  : null|ShapeContainerInterface
Container.
$extentX  : int
Extent X.
$extentY  : int
Extent Y.
$height  : int
Height.
$hyperlink  : null|Hyperlink
$name  : string
Name.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$placeholder  : null|Placeholder
$rotation  : int
Rotation.
$shadow  : null|Shadow
Shadow.
$shapeCollection  : array<int, AbstractShape>
Collection of shapes.
$width  : int
Width.
$border  : Border
Border.
$fill  : null|Fill
$hashIndex  : int
Hash index.

Methods

__clone()  : mixed
Magic Method : clone.
__construct()  : mixed
Create a new self.
addShape()  : static
createChartShape()  : Chart
Create chart shape.
createDrawingShape()  : File
Create drawing shape.
createLineShape()  : Line
Create line shape.
createRichTextShape()  : RichText
Create rich text shape.
createTableShape()  : Table
Create table shape.
getBorder()  : Border
getContainer()  : ShapeContainerInterface|null
Get Container, Slide or Group.
getExtentX()  : int
Get X Extent.
getExtentY()  : int
Get Y Extent.
getFill()  : Fill|null
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHeight()  : int
Get Height.
getHyperlink()  : Hyperlink
Get Hyperlink.
getName()  : string
Get Name.
getOffsetX()  : int
Get X Offset.
getOffsetY()  : int
Get Y Offset.
getPlaceholder()  : Placeholder|null
getRotation()  : int
Get Rotation.
getShadow()  : Shadow|null
getShapeCollection()  : array<int, AbstractShape>
Get collection of shapes.
getWidth()  : int
Get Width.
hasHyperlink()  : bool
Has Hyperlink?
isPlaceholder()  : bool
searchShapes()  : array<int, AbstractShape>
Search into collection of shapes for a name or/and a type.
setContainer()  : $this
Set Container, Slide or Group.
setFill()  : self
setHashIndex()  : $this
Set hash index.
setHeight()  : $this
Ignores setting the height, preserving the default behavior.
setHyperlink()  : self
Set Hyperlink.
setName()  : static
Set Name.
setOffsetX()  : $this
Ignores setting the X Offset, preserving the default behavior.
setOffsetY()  : $this
Ignores setting the Y Offset, preserving the default behavior.
setPlaceHolder()  : self
setRotation()  : $this
Set Rotation.
setShadow()  : $this
setShapeCollection()  : self
Get collection of shapes.
setWidth()  : self
Ignores setting the width, preserving the default behavior.
setWidthAndHeight()  : self
Set width and height with proportional resize.
unsetShape()  : static

Properties

$extentX

Extent X.

protected int $extentX

$extentY

Extent Y.

protected int $extentY

Methods

__construct()

Create a new self.

public __construct() : mixed

createChartShape()

Create chart shape.

public createChartShape() : Chart
Return values
Chart

createDrawingShape()

Create drawing shape.

public createDrawingShape() : File
Return values
File

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

createRichTextShape()

Create rich text shape.

public createRichTextShape() : RichText
Return values
RichText

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

getHeight()

Get Height.

public getHeight() : int
Return values
int

getName()

Get Name.

public getName() : string
Return values
string

getOffsetX()

Get X Offset.

public getOffsetX() : int
Return values
int

getOffsetY()

Get Y Offset.

public getOffsetY() : int
Return values
int

getRotation()

Get Rotation.

public getRotation() : int
Return values
int

getWidth()

Get Width.

public getWidth() : int
Return values
int

hasHyperlink()

Has Hyperlink?

public hasHyperlink() : bool
Return values
bool

isPlaceholder()

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

setContainer()

Set Container, Slide or Group.

public setContainer([ShapeContainerInterface|null $pValue = null ][, bool $pOverrideOld = false ]) : $this
Parameters
$pValue : ShapeContainerInterface|null = null
$pOverrideOld : bool = false

If a Slide has already been assigned, overwrite it and remove image from old Slide?

Return values
$this

setFill()

public setFill([Fill|null $pValue = null ]) : self
Parameters
$pValue : Fill|null = null
Return values
self

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

setHeight()

Ignores setting the height, preserving the default behavior.

public setHeight([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setHyperlink()

Set Hyperlink.

public setHyperlink([Hyperlink|null $pHyperlink = null ]) : self
Parameters
$pHyperlink : Hyperlink|null = null
Return values
self

setName()

Set Name.

public setName([string $pValue = '' ]) : static
Parameters
$pValue : string = ''
Return values
static

setOffsetX()

Ignores setting the X Offset, preserving the default behavior.

public setOffsetX([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setOffsetY()

Ignores setting the Y Offset, preserving the default behavior.

public setOffsetY([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setRotation()

Set Rotation.

public setRotation([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setShadow()

public setShadow([Shadow|null $pValue = null ]) : $this
Parameters
$pValue : Shadow|null = null
Return values
$this

setShapeCollection()

Get collection of shapes.

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

setWidth()

Ignores setting the width, preserving the default behavior.

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

setWidthAndHeight()

Set width and height with proportional resize.

public setWidthAndHeight([int $width = 0 ][, int $height = 0 ]) : self
Parameters
$width : int = 0
$height : int = 0
Return values
self

unsetShape()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results