PHPExcel_Worksheet_HeaderFooterDrawing

category | PHPExcel
package | PHPExcel_Worksheet
copyright | Copyright (c) 2006 - 2013 PHPExcel (http://www.codeplex.com/PHPExcel)

### Methods

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

    __clone()

## Create a new PHPExcel_Worksheet_HeaderFooterDrawing

    __construct()

## Get Coordinates

    getCoordinates() : string

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getCoordinates()
inherited_from | \PHPExcel_Worksheet_Drawing::getCoordinates()

### Returns

`string`

## Get Description

    getDescription() : string

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getDescription()
inherited_from | \PHPExcel_Worksheet_Drawing::getDescription()

### Returns

`string`

## Get Extension

    getExtension() : string

### Returns

`string`

## Get Filename

    getFilename() : string

### Returns

`string`

## Get hash code

    getHashCode() : string

### Returns

`string`Hash code

## Get Height

    getHeight() : int

### Returns

`int`

## Get image index

    getImageIndex() : int

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getImageIndex()
inherited_from | \PHPExcel_Worksheet_Drawing::getImageIndex()

### Returns

`int`

## Get indexed filename (using image index)

    getIndexedFilename() : string

Inherited

inherited_from | \PHPExcel_Worksheet_Drawing::getIndexedFilename()

### Returns

`string`

## Get Name

    getName() : string

### Returns

`string`

## Get OffsetX

    getOffsetX() : int

### Returns

`int`

## Get OffsetY

    getOffsetY() : int

### Returns

`int`

## Get Path

    getPath() : string

### Returns

`string`

## Get ResizeProportional

    getResizeProportional() : boolean

### Returns

`boolean`

## Get Rotation

    getRotation() : int

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getRotation()
inherited_from | \PHPExcel_Worksheet_Drawing::getRotation()

### Returns

`int`

## Get Shadow

    getShadow() : \PHPExcel_Worksheet_Drawing_Shadow

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getShadow()
inherited_from | \PHPExcel_Worksheet_Drawing::getShadow()

### Returns

`\PHPExcel_Worksheet_Drawing_Shadow`

## Get Width

    getWidth() : int

### Returns

`int`

## Get Worksheet

    getWorksheet() : \PHPExcel_Worksheet

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::getWorksheet()
inherited_from | \PHPExcel_Worksheet_Drawing::getWorksheet()

### Returns

`\PHPExcel_Worksheet`

## Set Coordinates

    setCoordinates(string $pValue) : \PHPExcel_Worksheet_BaseDrawing

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::setCoordinates()
inherited_from | \PHPExcel_Worksheet_Drawing::setCoordinates()

### Parameters

#### $pValue

`string`

### Returns

`\PHPExcel_Worksheet_BaseDrawing`

## Set Description

    setDescription(string $pValue) : \PHPExcel_Worksheet_BaseDrawing

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::setDescription()
inherited_from | \PHPExcel_Worksheet_Drawing::setDescription()

### Parameters

#### $pValue

`string`

### Returns

`\PHPExcel_Worksheet_BaseDrawing`

## Set Height

    setHeight(int $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`int`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set Name

    setName(string $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`string`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set OffsetX

    setOffsetX(int $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`int`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set OffsetY

    setOffsetY(int $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`int`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set Path

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

### Parameters

#### $pValue

`string`

File path

#### $pVerifyFile

`boolean`

Verify file

### Exceptions

`\PHPExcel_Exception` |

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set ResizeProportional

    setResizeProportional(boolean $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`boolean`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set Rotation

    setRotation(int $pValue) : \PHPExcel_Worksheet_BaseDrawing

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::setRotation()
inherited_from | \PHPExcel_Worksheet_Drawing::setRotation()

### Parameters

#### $pValue

`int`

### Returns

`\PHPExcel_Worksheet_BaseDrawing`

## Set Shadow

    setShadow(\PHPExcel_Worksheet_Drawing_Shadow $pValue) : \PHPExcel_Worksheet_BaseDrawing

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::setShadow()
inherited_from | \PHPExcel_Worksheet_Drawing::setShadow()

### Parameters

#### $pValue

`\PHPExcel_Worksheet_Drawing_Shadow`

### Exceptions

`\PHPExcel_Exception` |

### Returns

`\PHPExcel_Worksheet_BaseDrawing`

## Set Width

    setWidth(int $pValue) : \PHPExcel_Worksheet_HeaderFooterDrawing

### Parameters

#### $pValue

`int`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

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

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

author | Vincent@luo MSN:kele_100@hotmail.com

### Parameters

#### $width

`int`

#### $height

`int`

### Returns

`\PHPExcel_Worksheet_HeaderFooterDrawing`

## Set Worksheet

    setWorksheet(\PHPExcel_Worksheet $pValue, bool $pOverrideOld) : \PHPExcel_Worksheet_BaseDrawing

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::setWorksheet()
inherited_from | \PHPExcel_Worksheet_Drawing::setWorksheet()

### Parameters

#### $pValue

`\PHPExcel_Worksheet`

#### $pOverrideOld

`bool`

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

### Exceptions

`\PHPExcel_Exception` |

### Returns

`\PHPExcel_Worksheet_BaseDrawing`

### Properties

##

    $_coordinates : string

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_coordinates
inherited_from | \PHPExcel_Worksheet_Drawing::$$_coordinates

##

    $_description : string

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_description
inherited_from | \PHPExcel_Worksheet_Drawing::$$_description

##

    $_height : int

##

    $_name : string

##

    $_offsetX : int

##

    $_offsetY : int

##

    $_resizeProportional : boolean

##

    $_rotation : int

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_rotation
inherited_from | \PHPExcel_Worksheet_Drawing::$$_rotation

##

    $_shadow : \PHPExcel_Worksheet_Drawing_Shadow

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_shadow
inherited_from | \PHPExcel_Worksheet_Drawing::$$_shadow

##

    $_width : int

##

    $_worksheet : \PHPExcel_Worksheet

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_worksheet
inherited_from | \PHPExcel_Worksheet_Drawing::$$_worksheet

##

    $_imageCounter : int

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_imageCounter
inherited_from | \PHPExcel_Worksheet_Drawing::$$_imageCounter

##

    $_imageIndex : int

Inherited

inherited_from | \PHPExcel_Worksheet_BaseDrawing::$$_imageIndex
inherited_from | \PHPExcel_Worksheet_Drawing::$$_imageIndex

##

    $_path : string