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