Documentation

Shadow
in package
implements ComparableInterface

\PhpOffice\PhpPresentation\Style\Shadow.

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Constants

SHADOW_BOTTOM  = 'b'
SHADOW_BOTTOM_LEFT  = 'bl'
SHADOW_BOTTOM_RIGHT  = 'br'
SHADOW_CENTER  = 'ctr'
SHADOW_LEFT  = 'l'
SHADOW_TOP  = 't'
SHADOW_TOP_LEFT  = 'tl'
SHADOW_TOP_RIGHT  = 'tr'
TYPE_REFLECTION  = 'reflection'
TYPE_SHADOW_INNER  = 'innerShdw'
TYPE_SHADOW_OUTER  = 'outerShdw'

Properties

$alignment  : string
Shadow alignment.
$alpha  : int
$blurRadius  : int
Blur radius.
$color  : null|Color
$direction  : int
Shadow direction (in degrees).
$distance  : int
Shadow distance.
$hashIndex  : int
Hash index.
$type  : string
$visible  : bool
Visible.

Methods

__construct()  : mixed
Create a new \PhpOffice\PhpPresentation\Style\Shadow.
getAlignment()  : string
Get Shadow alignment.
getAlpha()  : int
Get Alpha.
getBlurRadius()  : int
Get Blur radius.
getColor()  : Color|null
Get Color.
getDirection()  : int
Get Shadow direction (in degrees).
getDistance()  : int
Get Shadow distance.
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getType()  : string
Get Type.
isVisible()  : bool
Get Visible.
setAlignment()  : self
Set Shadow alignment.
setAlpha()  : self
Set Alpha.
setBlurRadius()  : self
Set Blur radius.
setColor()  : self
Set Color.
setDirection()  : self
Set Shadow direction (in degrees).
setDistance()  : $this
Set Shadow distance.
setHashIndex()  : $this
Set hash index.
setType()  : self
Set Type.
setVisible()  : self
Set Visible.

Constants

SHADOW_BOTTOM

public mixed SHADOW_BOTTOM = 'b'

SHADOW_BOTTOM_LEFT

public mixed SHADOW_BOTTOM_LEFT = 'bl'

SHADOW_BOTTOM_RIGHT

public mixed SHADOW_BOTTOM_RIGHT = 'br'

SHADOW_CENTER

public mixed SHADOW_CENTER = 'ctr'

SHADOW_LEFT

public mixed SHADOW_LEFT = 'l'

SHADOW_TOP

public mixed SHADOW_TOP = 't'

SHADOW_TOP_LEFT

public mixed SHADOW_TOP_LEFT = 'tl'

SHADOW_TOP_RIGHT

public mixed SHADOW_TOP_RIGHT = 'tr'

TYPE_REFLECTION

public mixed TYPE_REFLECTION = 'reflection'

TYPE_SHADOW_INNER

public mixed TYPE_SHADOW_INNER = 'innerShdw'

TYPE_SHADOW_OUTER

public mixed TYPE_SHADOW_OUTER = 'outerShdw'

Properties

$alignment

Shadow alignment.

private string $alignment = self::SHADOW_BOTTOM_RIGHT

$blurRadius

Blur radius.

private int $blurRadius = 6

$direction

Shadow direction (in degrees).

private int $direction = 0

$distance

Shadow distance.

private int $distance = 2

$hashIndex

Hash index.

private int $hashIndex

$type

private string $type = self::TYPE_SHADOW_OUTER

$visible

Visible.

private bool $visible = false

Methods

__construct()

Create a new \PhpOffice\PhpPresentation\Style\Shadow.

public __construct() : mixed

getAlignment()

Get Shadow alignment.

public getAlignment() : string
Return values
string

getAlpha()

Get Alpha.

public getAlpha() : int
Return values
int

getBlurRadius()

Get Blur radius.

public getBlurRadius() : int
Return values
int

getDirection()

Get Shadow direction (in degrees).

public getDirection() : int
Return values
int

getDistance()

Get Shadow distance.

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

getType()

Get Type.

public getType() : string
Return values
string

isVisible()

Get Visible.

public isVisible() : bool
Return values
bool

setAlignment()

Set Shadow alignment.

public setAlignment([string $pValue = self::SHADOW_BOTTOM_RIGHT ]) : self
Parameters
$pValue : string = self::SHADOW_BOTTOM_RIGHT
Return values
self

setAlpha()

Set Alpha.

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

setBlurRadius()

Set Blur radius.

public setBlurRadius([int $pValue = 6 ]) : self
Parameters
$pValue : int = 6
Return values
self

setColor()

Set Color.

public setColor([Color|null $pValue = null ]) : self
Parameters
$pValue : Color|null = null
Return values
self

setDirection()

Set Shadow direction (in degrees).

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

setDistance()

Set Shadow distance.

public setDistance([int $pValue = 2 ]) : $this
Parameters
$pValue : int = 2
Return values
$this

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

setType()

Set Type.

public setType([string $pValue = self::TYPE_SHADOW_OUTER ]) : self
Parameters
$pValue : string = self::TYPE_SHADOW_OUTER
Return values
self

setVisible()

Set Visible.

public setVisible([bool $pValue = false ]) : self
Parameters
$pValue : bool = false
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results