PHPExcel_Worksheet

# Class: PHPExcel_Worksheet_BaseDrawing Source Location: /PHPExcel/Worksheet/BaseDrawing.php
### Class Overview
PHPExcel_Worksheet_BaseDrawing #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_coordinates $_description $_height $_imageCounter $_imageIndex $_name $_offsetX $_offsetY $_resizeProportional $_rotation $_shadow $_width $_worksheet | ### Methods __construct getCoordinates getDescription getHashCode getHeight getImageIndex getName getOffsetX getOffsetY getResizeProportional getRotation getShadow getWidth getWorksheet setCoordinates setDescription setHeight setName setOffsetX setOffsetY setResizeProportional setRotation setShadow setWidth setWidthAndHeight setWorksheet __clone
### Child classes: PHPExcel_Worksheet_Drawing PHPExcel_Worksheet_Drawing PHPExcel_Worksheet_MemoryDrawing PHPExcel_Worksheet_MemoryDrawing
### Class Details [line 53] PHPExcel_Worksheet_BaseDrawing PHPExcel_Worksheet_BaseDrawing #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### static $_imageCounter = 0 [line 60] Image counter Image counter #### Tags:
access: | private
Type: | int
[ Top ] #### $_coordinates = [line 95] Coordinates Coordinates #### Tags:
access: | protected
Type: | string
[ Top ] #### $_description = [line 81] Description Description #### Tags:
access: | protected
Type: | string
[ Top ] #### $_height = [line 123] Height Height #### Tags:
access: | protected
Type: | int
[ Top ] #### $_imageIndex = 0 [line 67] Image index Image index #### Tags:
access: | private
Type: | int
[ Top ] #### $_name = [line 74] Name Name #### Tags:
access: | protected
Type: | string
[ Top ] #### $_offsetX = [line 102] Offset X Offset X #### Tags:
access: | protected
Type: | int
[ Top ] #### $_offsetY = [line 109] Offset Y Offset Y #### Tags:
access: | protected
Type: | int
[ Top ] #### $_resizeProportional = [line 130] Proportional resize Proportional resize #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $_rotation = [line 137] Rotation Rotation #### Tags:
access: | protected
Type: | int
[ Top ] #### $_shadow = [line 144] Shadow Shadow #### Tags:
access: | protected
Type: | PHPExcel_Worksheet_Drawing_Shadow
[ Top ] #### $_width = [line 116] Width Width #### Tags:
access: | protected
Type: | int
[ Top ] #### $_worksheet = [line 88] Worksheet Worksheet #### Tags:
access: | protected
Type: | PHPExcel_Worksheet
[ Top ] ### Class Methods ### constructor __construct [line 149]
`PHPExcel_Worksheet_BaseDrawing __construct( )`
Create a new PHPExcel_Worksheet_BaseDrawing Create a new PHPExcel_Worksheet_BaseDrawing #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_Drawing::__construct() Create a new PHPExcel_Worksheet_Drawing PHPExcel_Worksheet_HeaderFooterDrawing::__construct() Create a new PHPExcel_Worksheet_HeaderFooterDrawing PHPExcel_Worksheet_MemoryDrawing::__construct() Create a new PHPExcel_Worksheet_MemoryDrawing [ Top ] ### method getCoordinates [line 268]
`string getCoordinates( )`
Get Coordinates Get Coordinates #### Tags:
access: | public
[ Top ] ### method getDescription [line 203]
`string getDescription( )`
Get Description Get Description #### Tags:
access: | public
[ Top ] ### method getHashCode [line 473]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
Overridden in child classes as: PHPExcel_Worksheet_Drawing::getHashCode() Get hash code PHPExcel_Worksheet_HeaderFooterDrawing::getHashCode() Get hash code PHPExcel_Worksheet_MemoryDrawing::getHashCode() Get hash code [ Top ] ### method getHeight [line 356]
`int getHeight( )`
Get Height Get Height #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getHeight() Get Height [ Top ] ### method getImageIndex [line 174]
`int getImageIndex( )`
Get image index Get image index #### Tags:
access: | public
[ Top ] ### method getName [line 183]
`string getName( )`
Get Name Get Name #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getName() Get Name [ Top ] ### method getOffsetX [line 288]
`int getOffsetX( )`
Get OffsetX Get OffsetX #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetX() Get OffsetX [ Top ] ### method getOffsetY [line 308]
`int getOffsetY( )`
Get OffsetY Get OffsetY #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetY() Get OffsetY [ Top ] ### method getResizeProportional [line 412]
`boolean getResizeProportional( )`
Get ResizeProportional Get ResizeProportional #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getResizeProportional() Get ResizeProportional [ Top ] ### method getRotation [line 432]
`int getRotation( )`
Get Rotation Get Rotation #### Tags:
access: | public
[ Top ] ### method getShadow [line 452]
`PHPExcel_Worksheet_Drawing_Shadow getShadow( )`
Get Shadow Get Shadow #### Tags:
access: | public
[ Top ] ### method getWidth [line 328]
`int getWidth( )`
Get Width Get Width #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::getWidth() Get Width [ Top ] ### method getWorksheet [line 223]
`PHPExcel_Worksheet getWorksheet( )`
Get Worksheet Get Worksheet #### Tags:
access: | public
[ Top ] ### method setCoordinates [line 278]
`PHPExcel_Worksheet_BaseDrawing setCoordinates( [string $pValue = 'A1'])`
Set Coordinates Set Coordinates #### Tags:
access: | public
#### Parameters:
string | $pValue |
[ Top ] ### method setDescription [line 213]
`PHPExcel_Worksheet_BaseDrawing setDescription( [string $pValue = ''])`
Set Description Set Description #### Tags:
access: | public
#### Parameters:
string | $pValue |
[ Top ] ### method setHeight [line 366]
`PHPExcel_Worksheet_BaseDrawing setHeight( [int $pValue = 0])`
Set Height Set Height #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setHeight() Set Height #### Parameters:
int | $pValue |
[ Top ] ### method setName [line 193]
`PHPExcel_Worksheet_BaseDrawing setName( [string $pValue = ''])`
Set Name Set Name #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setName() Set Name #### Parameters:
string | $pValue |
[ Top ] ### method setOffsetX [line 298]
`PHPExcel_Worksheet_BaseDrawing setOffsetX( [int $pValue = 0])`
Set OffsetX Set OffsetX #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetX() Set OffsetX #### Parameters:
int | $pValue |
[ Top ] ### method setOffsetY [line 318]
`PHPExcel_Worksheet_BaseDrawing setOffsetY( [int $pValue = 0])`
Set OffsetY Set OffsetY #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetY() Set OffsetY #### Parameters:
int | $pValue |
[ Top ] ### method setResizeProportional [line 422]
`PHPExcel_Worksheet_BaseDrawing setResizeProportional( [boolean $pValue = true])`
Set ResizeProportional Set ResizeProportional #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setResizeProportional() Set ResizeProportional #### Parameters:
boolean | $pValue |
[ Top ] ### method setRotation [line 442]
`PHPExcel_Worksheet_BaseDrawing setRotation( [int $pValue = 0])`
Set Rotation Set Rotation #### Tags:
access: | public
#### Parameters:
int | $pValue |
[ Top ] ### method setShadow [line 463]
`PHPExcel_Worksheet_BaseDrawing setShadow( [ $pValue = null])`
Set Shadow Set Shadow #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Worksheet_Drawing_Shadow | $pValue |
[ Top ] ### method setWidth [line 338]
`PHPExcel_Worksheet_BaseDrawing setWidth( [int $pValue = 0])`
Set Width Set Width #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setWidth() Set Width #### Parameters:
int | $pValue |
[ Top ] ### method setWidthAndHeight [line 392]
`PHPExcel_Worksheet_BaseDrawing setWidthAndHeight( [int $width = 0], [int $height = 0])`
Set width and height with proportional resize Set width and height with proportional resize Example: $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120); #### Tags:
author: | Vincent@luo MSN:kele_100@hotmail.com
access: | public
Overridden in child classes as: PHPExcel_Worksheet_HeaderFooterDrawing::setWidthAndHeight() Set width and height with proportional resize #### Parameters:
int | $width |
int | $height |
[ Top ] ### method setWorksheet [line 235]
`PHPExcel_Worksheet_BaseDrawing setWorksheet( [PHPExcel_Worksheet $pValue = null], [bool $pOverrideOld = false])`
Set Worksheet Set Worksheet #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Worksheet | $pValue |
bool | $pOverrideOld | If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?
[ Top ] ### method __clone [line 492]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
Overridden in child classes as: PHPExcel_Worksheet_Drawing::__clone() Implement PHP __clone to create a deep clone, not just a shallow copy. PHPExcel_Worksheet_HeaderFooterDrawing::__clone() Implement PHP __clone to create a deep clone, not just a shallow copy. PHPExcel_Worksheet_MemoryDrawing::__clone() Implement PHP __clone to create a deep clone, not just a shallow copy. [ Top ] Documentation generated on Mon, 11 Jan 2010 08:06:26 +0100 by phpDocumentor 1.4.1