class PHPExcel_Worksheet_BaseDrawing implements PHPExcel_IComparable

PHPExcelWorksheetBaseDrawing

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 PHPExcelWorksheetBaseDrawing

int
getImageIndex()

Get image index

string
getName()

Get Name

setName(string $pValue = '')

Set Name

string
getDescription()

Get Description

setDescription(string $pValue = '')

Set Description

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

Set Worksheet

string
getCoordinates()

Get Coordinates

setCoordinates(string $pValue = 'A1')

Set 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

setRotation(int $pValue)

Set Rotation

string
getHashCode()

Get hash code

__clone()

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

Details

at line 133
__construct()

Create a new PHPExcelWorksheetBaseDrawing

at line 158
int getImageIndex()

Get image index

Return Value

int

at line 168
string getName()

Get Name

Return Value

string

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

Set Name

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 190
string getDescription()

Get Description

Return Value

string

at line 201
PHPExcel_Worksheet_BaseDrawing setDescription(string $pValue = '')

Set Description

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 212
PHPExcel_Worksheet getWorksheet()

Get Worksheet

Return Value

PHPExcel_Worksheet

at line 225
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

at line 259
string getCoordinates()

Get Coordinates

Return Value

string

at line 270
PHPExcel_Worksheet_BaseDrawing setCoordinates(string $pValue = 'A1')

Set Coordinates

Parameters

string $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 281
int getOffsetX()

Get OffsetX

Return Value

int

at line 292
PHPExcel_Worksheet_BaseDrawing setOffsetX(int $pValue)

Set OffsetX

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 303
int getOffsetY()

Get OffsetY

Return Value

int

at line 314
PHPExcel_Worksheet_BaseDrawing setOffsetY(int $pValue)

Set OffsetY

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 325
int getWidth()

Get Width

Return Value

int

at line 336
PHPExcel_Worksheet_BaseDrawing setWidth(int $pValue)

Set Width

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 355
int getHeight()

Get Height

Return Value

int

at line 366
PHPExcel_Worksheet_BaseDrawing setHeight(int $pValue)

Set Height

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 393
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 418
boolean getResizeProportional()

Get ResizeProportional

Return Value

boolean

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

Set ResizeProportional

Parameters

boolean $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 440
int getRotation()

Get Rotation

Return Value

int

at line 451
PHPExcel_Worksheet_BaseDrawing setRotation(int $pValue)

Set Rotation

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

at line 462
PHPExcel_Worksheet_Drawing_Shadow getShadow()

Get Shadow

at line 474
PHPExcel_Worksheet_BaseDrawing setShadow(PHPExcel_Worksheet_Drawing_Shadow $pValue = null)

Set Shadow

at line 485
string getHashCode()

Get hash code

Return Value

string Hash code

at line 505
__clone()

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