class PHPExcel_Worksheet_HeaderFooterDrawing extends PHPExcel_Worksheet_Drawing implements PHPExcel_IComparable

PHPExcelWorksheetHeaderFooterDrawing

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

Methods

__construct()

Create a new PHPExcelWorksheetHeaderFooterDrawing

int
getImageIndex()

Get image index

string
getName()

Get Name

setName(string $pValue = '')

Set Name

string
getDescription()

Get Description

setWorksheet(PHPExcel_Worksheet $pValue = null, bool $pOverrideOld = false)

Set Worksheet

string
getCoordinates()

Get Coordinates

int
getOffsetX()

Get OffsetX

setOffsetX(int $pValue)

Set OffsetX

int
getOffsetY()

Get OffsetY

setOffsetY(int $pValue)

Set OffsetY

int
getWidth()

Get Width

setWidth(int $pValue)

Set Width

int
getHeight()

Get Height

setHeight(int $pValue)

Set Height

setWidthAndHeight(int $width, int $height)

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

boolean
getResizeProportional()

Get ResizeProportional

setResizeProportional(boolean $pValue = true)

Set ResizeProportional

int
getRotation()

Get Rotation

string
getHashCode()

Get hash code

__clone()

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

string
getFilename()

Get Filename

string
getIndexedFilename()

Get indexed filename (using image index)

string
getExtension()

Get Extension

string
getPath()

Get Path

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

Set Path

Details

at line 91
__construct()

Create a new PHPExcelWorksheetHeaderFooterDrawing

int getImageIndex()

Get image index

Return Value

int

at line 108
string getName()

Get Name

Return Value

string

at line 119
PHPExcel_Worksheet_BaseDrawing setName(string $pValue = '')

Set Name

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

string getDescription()

Get Description

Return Value

string

PHPExcel_Worksheet_BaseDrawing setDescription(string $pValue = '')

Set Description

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

PHPExcel_Worksheet getWorksheet()

Get Worksheet

Return Value

PHPExcel_Worksheet

PHPExcel_Worksheet_BaseDrawing setWorksheet(PHPExcel_Worksheet $pValue = null, bool $pOverrideOld = false)

Set Worksheet

Parameters

PHPExcel_Worksheet $pValue
bool $pOverrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?

Return Value

PHPExcel_Worksheet_BaseDrawing

Exceptions

PHPExcel_Exception

string getCoordinates()

Get Coordinates

Return Value

string

PHPExcel_Worksheet_BaseDrawing setCoordinates(string $pValue = 'A1')

Set Coordinates

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 130
int getOffsetX()

Get OffsetX

Return Value

int

at line 141
PHPExcel_Worksheet_BaseDrawing setOffsetX(int $pValue)

Set OffsetX

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 152
int getOffsetY()

Get OffsetY

Return Value

int

at line 163
PHPExcel_Worksheet_BaseDrawing setOffsetY(int $pValue)

Set OffsetY

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 174
int getWidth()

Get Width

Return Value

int

at line 185
PHPExcel_Worksheet_BaseDrawing setWidth(int $pValue)

Set Width

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 204
int getHeight()

Get Height

Return Value

int

at line 215
PHPExcel_Worksheet_BaseDrawing setHeight(int $pValue)

Set Height

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 242
PHPExcel_Worksheet_BaseDrawing setWidthAndHeight(int $width, int $height)

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

Parameters

int $width
int $height

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 263
boolean getResizeProportional()

Get ResizeProportional

Return Value

boolean

at line 274
PHPExcel_Worksheet_BaseDrawing setResizeProportional(boolean $pValue = true)

Set ResizeProportional

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

int getRotation()

Get Rotation

Return Value

int

PHPExcel_Worksheet_BaseDrawing setRotation(int $pValue)

Set Rotation

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 343
string getHashCode()

Get hash code

Return Value

string Hash code

at line 359
__clone()

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

at line 285
string getFilename()

Get Filename

Return Value

string

string getIndexedFilename()

Get indexed filename (using image index)

Return Value

string

at line 295
string getExtension()

Get Extension

Return Value

string

at line 306
string getPath()

Get Path

Return Value

string

at line 319
PHPExcel_Worksheet_Drawing setPath(string $pValue = '', boolean $pVerifyFile = true)

Set Path

Parameters

string $pValue File path
boolean $pVerifyFile Verify file

Return Value

PHPExcel_Worksheet_Drawing

Exceptions

PHPExcel_Exception