class Drawing extends BaseDrawing (View source)

Properties

protected string $name Name. from BaseDrawing
protected string $description Description. from BaseDrawing
protected Worksheet $worksheet Worksheet. from BaseDrawing
protected string $coordinates Coordinates. from BaseDrawing
protected int $offsetX Offset X. from BaseDrawing
protected int $offsetY Offset Y. from BaseDrawing
protected int $width Width. from BaseDrawing
protected int $height Height. from BaseDrawing
protected bool $resizeProportional Proportional resize. from BaseDrawing
protected int $rotation Rotation. from BaseDrawing
protected Shadow $shadow Shadow. from BaseDrawing

Methods

__construct()

Create a new Drawing.

int
getImageIndex()

Get image index.

string
getName()

Get Name.

setName(string $pValue)

Set Name.

string
getDescription()

Get Description.

setDescription(string $description)

Set Description.

getWorksheet()

Get Worksheet.

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

Set Worksheet.

string
getCoordinates()

Get Coordinates.

setCoordinates(string $pValue)

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.

bool
getResizeProportional()

Get ResizeProportional.

setResizeProportional(bool $pValue)

Set ResizeProportional.

int
getRotation()

Get Rotation.

setRotation(int $pValue)

Set Rotation.

getShadow()

Get Shadow.

setShadow(Shadow $pValue = null)

Set Shadow.

string
getHashCode()

Get hash code.

__clone()

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

setHyperlink(Hyperlink $pHyperlink = null)

No description

null|Hyperlink
getHyperlink()

No description

string
getFilename()

Get Filename.

string
getIndexedFilename()

Get indexed filename (using image index).

string
getExtension()

Get Extension.

string
getPath()

Get Path.

setPath(string $pValue, bool $pVerifyFile = true)

Set Path.

Details

__construct()

Create a new Drawing.

int getImageIndex()

Get image index.

Return Value

int

string getName()

Get Name.

Return Value

string

BaseDrawing setName(string $pValue)

Set Name.

Parameters

string $pValue

Return Value

BaseDrawing

string getDescription()

Get Description.

Return Value

string

BaseDrawing setDescription(string $description)

Set Description.

Parameters

string $description

Return Value

BaseDrawing

Worksheet getWorksheet()

Get Worksheet.

Return Value

Worksheet

BaseDrawing setWorksheet(Worksheet $pValue = null, bool $pOverrideOld = false)

Set Worksheet.

Parameters

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

Return Value

BaseDrawing

Exceptions

Exception

string getCoordinates()

Get Coordinates.

Return Value

string

BaseDrawing setCoordinates(string $pValue)

Set Coordinates.

Parameters

string $pValue eg: 'A1'

Return Value

BaseDrawing

int getOffsetX()

Get OffsetX.

Return Value

int

BaseDrawing setOffsetX(int $pValue)

Set OffsetX.

Parameters

int $pValue

Return Value

BaseDrawing

int getOffsetY()

Get OffsetY.

Return Value

int

BaseDrawing setOffsetY(int $pValue)

Set OffsetY.

Parameters

int $pValue

Return Value

BaseDrawing

int getWidth()

Get Width.

Return Value

int

BaseDrawing setWidth(int $pValue)

Set Width.

Parameters

int $pValue

Return Value

BaseDrawing

int getHeight()

Get Height.

Return Value

int

BaseDrawing setHeight(int $pValue)

Set Height.

Parameters

int $pValue

Return Value

BaseDrawing

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

BaseDrawing

bool getResizeProportional()

Get ResizeProportional.

Return Value

bool

BaseDrawing setResizeProportional(bool $pValue)

Set ResizeProportional.

Parameters

bool $pValue

Return Value

BaseDrawing

int getRotation()

Get Rotation.

Return Value

int

BaseDrawing setRotation(int $pValue)

Set Rotation.

Parameters

int $pValue

Return Value

BaseDrawing

Shadow getShadow()

Get Shadow.

Return Value

Shadow

BaseDrawing setShadow(Shadow $pValue = null)

Set Shadow.

Parameters

Shadow $pValue

Return Value

BaseDrawing

string getHashCode()

Get hash code.

Return Value

string Hash code

__clone()

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

Parameters

Hyperlink $pHyperlink

Return Value

null|Hyperlink

string getFilename()

Get Filename.

Return Value

string

string getIndexedFilename()

Get indexed filename (using image index).

Return Value

string

string getExtension()

Get Extension.

Return Value

string

string getPath()

Get Path.

Return Value

string

Drawing setPath(string $pValue, bool $pVerifyFile = true)

Set Path.

Parameters

string $pValue File path
bool $pVerifyFile Verify file

Return Value

Drawing

Exceptions

Exception