class PHPExcel_Worksheet_MemoryDrawing extends PHPExcel_Worksheet_BaseDrawing implements PHPExcel_IComparable

PHPExcelWorksheetMemoryDrawing

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

Constants

RENDERING_DEFAULT

RENDERING_PNG

RENDERING_GIF

RENDERING_JPEG

MIMETYPE_DEFAULT

MIMETYPE_PNG

MIMETYPE_GIF

MIMETYPE_JPEG

Methods

__construct()

Create a new PHPExcelWorksheetMemoryDrawing

int
getImageIndex()

Get image index

string
getName()

Get Name

string
getDescription()

Get Description

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

Set Worksheet

string
getCoordinates()

Get Coordinates

int
getOffsetX()

Get OffsetX

int
getOffsetY()

Get OffsetY

int
getHeight()

Get 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.

resource
getImageResource()

Get image resource

setImageResource($value = null)

Set image resource

string
getRenderingFunction()

Get rendering function

setRenderingFunction(string $value = PHPExcel_Worksheet_MemoryDrawing::RENDERING_DEFAULT)

Set rendering function

string
getMimeType()

Get mime type

setMimeType(string $value = PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_DEFAULT)

Set mime type

string
getIndexedFilename()

Get indexed filename (using image index)

Details

at line 82
__construct()

Create a new PHPExcelWorksheetMemoryDrawing

int getImageIndex()

Get image index

Return Value

int

string getName()

Get Name

Return Value

string

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

int getOffsetX()

Get OffsetX

Return Value

int

PHPExcel_Worksheet_BaseDrawing setOffsetX(int $pValue)

Set OffsetX

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

int getOffsetY()

Get OffsetY

Return Value

int

PHPExcel_Worksheet_BaseDrawing setOffsetY(int $pValue)

Set OffsetY

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

int getWidth()

Get Width

Return Value

int

PHPExcel_Worksheet_BaseDrawing setWidth(int $pValue)

Set Width

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

int getHeight()

Get Height

Return Value

int

PHPExcel_Worksheet_BaseDrawing setHeight(int $pValue)

Set Height

Parameters

int $pValue

Return Value

PHPExcel_Worksheet_BaseDrawing

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

boolean getResizeProportional()

Get ResizeProportional

Return Value

boolean

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 185
string getHashCode()

Get hash code

Return Value

string Hash code

at line 199
__clone()

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

at line 99
resource getImageResource()

Get image resource

Return Value

resource

at line 110
PHPExcel_Worksheet_MemoryDrawing setImageResource($value = null)

Set image resource

Parameters

$value resource

Return Value

PHPExcel_Worksheet_MemoryDrawing

at line 127
string getRenderingFunction()

Get rendering function

Return Value

string

at line 138
PHPExcel_Worksheet_MemoryDrawing setRenderingFunction(string $value = PHPExcel_Worksheet_MemoryDrawing::RENDERING_DEFAULT)

Set rendering function

Parameters

string $value

Return Value

PHPExcel_Worksheet_MemoryDrawing

at line 149
string getMimeType()

Get mime type

Return Value

string

at line 160
PHPExcel_Worksheet_MemoryDrawing setMimeType(string $value = PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_DEFAULT)

Set mime type

Parameters

string $value

Return Value

PHPExcel_Worksheet_MemoryDrawing

at line 171
string getIndexedFilename()

Get indexed filename (using image index)

Return Value

string