\PHPExcel_Worksheet_HeaderFooterDrawing

PHPExcel_Worksheet_HeaderFooterDrawing

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
getFilename()
getIndexedFilename()
getExtension()
getPath()
setPath()
getHashCode()
__clone()
getImageIndex()
getName()
setName()
getDescription()
setDescription()
getWorksheet()
setWorksheet()
getCoordinates()
setCoordinates()
getOffsetX()
setOffsetX()
getOffsetY()
setOffsetY()
getWidth()
setWidth()
getHeight()
setHeight()
setWidthAndHeight()
getResizeProportional()
setResizeProportional()
getRotation()
setRotation()
getShadow()
setShadow()
No public properties found
No constants found
No protected methods found
$name
$description
$worksheet
$coordinates
$offsetX
$offsetY
$width
$height
$resizeProportional
$rotation
$shadow
N/A
No private methods found
$path
$imageCounter
$imageIndex
N/A

Properties

$name

$name : string

Name

Type

string

$description

$description : string

Description

Type

string

$coordinates

$coordinates : string

Coordinates

Type

string

$offsetX

$offsetX : integer

Offset X

Type

integer

$offsetY

$offsetY : integer

Offset Y

Type

integer

$width

$width : integer

Width

Type

integer

$height

$height : integer

Height

Type

integer

$resizeProportional

$resizeProportional : boolean

Proportional resize

Type

boolean

$rotation

$rotation : integer

Rotation

Type

integer

$path

$path : string

Path

Type

string

$imageCounter

$imageCounter : integer

Image counter

Type

integer

$imageIndex

$imageIndex : integer

Image index

Type

integer

Methods

__construct()

__construct() 

Create a new PHPExcel_Worksheet_HeaderFooterDrawing

getFilename()

getFilename() : string

Get Filename

Returns

string

getIndexedFilename()

getIndexedFilename() : string

Get indexed filename (using image index)

Returns

string

getExtension()

getExtension() : string

Get Extension

Returns

string

getPath()

getPath() : string

Get Path

Returns

string

setPath()

setPath(string  $pValue = '', boolean  $pVerifyFile = true) : \PHPExcel_Worksheet_HeaderFooterDrawing

Set Path

Parameters

string $pValue

File path

boolean $pVerifyFile

Verify file

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_HeaderFooterDrawing

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.

getImageIndex()

getImageIndex() : integer

Get image index

Returns

integer

getName()

getName() : string

Get Name

Returns

string

getDescription()

getDescription() : string

Get Description

Returns

string

setDescription()

setDescription(string  $pValue = '') : \PHPExcel_Worksheet_BaseDrawing

Set Description

Parameters

string $pValue

Returns

\PHPExcel_Worksheet_BaseDrawing

getWorksheet()

getWorksheet() : \PHPExcel_Worksheet

Get Worksheet

Returns

\PHPExcel_Worksheet

setWorksheet()

setWorksheet(\PHPExcel_Worksheet  $pValue = null, boolean  $pOverrideOld = false) : \PHPExcel_Worksheet_BaseDrawing

Set Worksheet

Parameters

\PHPExcel_Worksheet $pValue
boolean $pOverrideOld

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

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_BaseDrawing

getCoordinates()

getCoordinates() : string

Get Coordinates

Returns

string

setCoordinates()

setCoordinates(string  $pValue = 'A1') : \PHPExcel_Worksheet_BaseDrawing

Set Coordinates

Parameters

string $pValue

Returns

\PHPExcel_Worksheet_BaseDrawing

getOffsetX()

getOffsetX() : integer

Get OffsetX

Returns

integer

getOffsetY()

getOffsetY() : integer

Get OffsetY

Returns

integer

getWidth()

getWidth() : integer

Get Width

Returns

integer

getHeight()

getHeight() : integer

Get Height

Returns

integer

setWidthAndHeight()

setWidthAndHeight(integer  $width, integer  $height) : \PHPExcel_Worksheet_HeaderFooterDrawing

Set width and height with proportional resize Example: <code> $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120); </code>

Parameters

integer $width
integer $height

Returns

\PHPExcel_Worksheet_HeaderFooterDrawing

getResizeProportional()

getResizeProportional() : boolean

Get ResizeProportional

Returns

boolean

setResizeProportional()

setResizeProportional(boolean  $pValue = true) : \PHPExcel_Worksheet_HeaderFooterDrawing

Set ResizeProportional

Parameters

boolean $pValue

Returns

\PHPExcel_Worksheet_HeaderFooterDrawing

getRotation()

getRotation() : integer

Get Rotation

Returns

integer

setRotation()

setRotation(integer  $pValue) : \PHPExcel_Worksheet_BaseDrawing

Set Rotation

Parameters

integer $pValue

Returns

\PHPExcel_Worksheet_BaseDrawing