Documentation

BaseDrawing implements IComparable

Interfaces, Classes and Traits

IComparable

Table of Contents

EDIT_AS_ABSOLUTE  = 'absolute'
EDIT_AS_ONECELL  = 'oneCell'
EDIT_AS_TWOCELL  = 'twoCell'
VALID_EDIT_AS  = [self::EDIT_AS_ABSOLUTE, self::EDIT_AS_ONECELL, self::EDIT_AS_TWOCELL]
$coordinates  : string
Coordinates.
$coordinates2  : string
Coordinates2.
$description  : string
Description.
$editAs  : string
The editAs attribute, used only with two cell anchor.
$height  : int
Height.
$imageHeight  : int
Pixel width of image. See $height for the size the Drawing will be in the sheet.
$imageWidth  : int
Pixel width of image. See $width for the size the Drawing will be in the sheet.
$name  : string
Name.
$offsetX  : int
Offset X.
$offsetX2  : int
Offset X2.
$offsetY  : int
Offset Y.
$offsetY2  : int
Offset Y2.
$resizeProportional  : bool
Proportional resize.
$rotation  : int
Rotation.
$shadow  : Shadow
Shadow.
$type  : int
Image type.
$width  : int
Width.
$worksheet  : null|Worksheet
Worksheet.
$hyperlink  : null|Hyperlink
Image hyperlink.
$imageCounter  : int
Image counter.
$imageIndex  : int
Image index.
__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new BaseDrawing.
getCoordinates()  : string
getCoordinates2()  : string
getDescription()  : string
getEditAs()  : string
getHashCode()  : string
Get hash code.
getHeight()  : int
getHyperlink()  : Hyperlink|null
getImageHeight()  : int
getImageIndex()  : int
getImageWidth()  : int
getName()  : string
getOffsetX()  : int
getOffsetX2()  : int
getOffsetY()  : int
getOffsetY2()  : int
getResizeProportional()  : bool
getRotation()  : int
getShadow()  : Shadow
getType()  : int
Get Image Type.
getWidth()  : int
getWorksheet()  : Worksheet|null
setCoordinates()  : self
setCoordinates2()  : self
setDescription()  : self
setEditAs()  : self
setHeight()  : self
setHyperlink()  : void
setName()  : self
setOffsetX()  : self
setOffsetX2()  : self
setOffsetY()  : self
setOffsetY2()  : self
setResizeProportional()  : self
setRotation()  : self
setShadow()  : self
setWidth()  : self
setWidthAndHeight()  : self
Set width and height with proportional resize.
setWorksheet()  : self
Set Worksheet.
validEditAs()  : bool
setSizesAndType()  : void
Set Fact Sizes and Type of Image.

Constants

EDIT_AS_ABSOLUTE

public mixed EDIT_AS_ABSOLUTE = 'absolute'

EDIT_AS_ONECELL

public mixed EDIT_AS_ONECELL = 'oneCell'

EDIT_AS_TWOCELL

public mixed EDIT_AS_TWOCELL = 'twoCell'

VALID_EDIT_AS

private mixed VALID_EDIT_AS = [self::EDIT_AS_ABSOLUTE, self::EDIT_AS_ONECELL, self::EDIT_AS_TWOCELL]

Properties

$coordinates

Coordinates.

protected string $coordinates = 'A1'

$coordinates2

Coordinates2.

protected string $coordinates2 = ''

$description

Description.

protected string $description = ''

$editAs

The editAs attribute, used only with two cell anchor.

protected string $editAs = ''

$imageHeight

Pixel width of image. See $height for the size the Drawing will be in the sheet.

protected int $imageHeight = 0

$imageWidth

Pixel width of image. See $width for the size the Drawing will be in the sheet.

protected int $imageWidth = 0

$resizeProportional

Proportional resize.

protected bool $resizeProportional = true

$type

Image type.

protected int $type = IMAGETYPE_UNKNOWN

$imageCounter

Image counter.

private static int $imageCounter = 0

$imageIndex

Image index.

private int $imageIndex = 0

Methods

__clone()

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

public __clone() : mixed
Return values
mixed

__construct()

Create a new BaseDrawing.

public __construct() : mixed
Return values
mixed

getCoordinates()

public getCoordinates() : string
Return values
string

getCoordinates2()

public getCoordinates2() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getEditAs()

public getEditAs() : string
Return values
string

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string

Hash code

getHeight()

public getHeight() : int
Return values
int

getImageHeight()

public getImageHeight() : int
Return values
int

getImageIndex()

public getImageIndex() : int
Return values
int

getImageWidth()

public getImageWidth() : int
Return values
int

getName()

public getName() : string
Return values
string

getOffsetX()

public getOffsetX() : int
Return values
int

getOffsetX2()

public getOffsetX2() : int
Return values
int

getOffsetY()

public getOffsetY() : int
Return values
int

getOffsetY2()

public getOffsetY2() : int
Return values
int

getResizeProportional()

public getResizeProportional() : bool
Return values
bool

getRotation()

public getRotation() : int
Return values
int

getType()

Get Image Type.

public getType() : int
Return values
int

getWidth()

public getWidth() : int
Return values
int

setCoordinates()

public setCoordinates(string $coordinates) : self
Parameters
$coordinates : string
Return values
self

setCoordinates2()

public setCoordinates2(string $coordinates2) : self
Parameters
$coordinates2 : string
Return values
self

setDescription()

public setDescription(string $description) : self
Parameters
$description : string
Return values
self

setEditAs()

public setEditAs(string $editAs) : self
Parameters
$editAs : string
Return values
self

setHeight()

public setHeight(int $height) : self
Parameters
$height : int
Return values
self
public setHyperlink([Hyperlink|null $hyperlink = null ]) : void
Parameters
$hyperlink : Hyperlink|null = null
Return values
void

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self

setOffsetX()

public setOffsetX(int $offsetX) : self
Parameters
$offsetX : int
Return values
self

setOffsetX2()

public setOffsetX2(int $offsetX2) : self
Parameters
$offsetX2 : int
Return values
self

setOffsetY()

public setOffsetY(int $offsetY) : self
Parameters
$offsetY : int
Return values
self

setOffsetY2()

public setOffsetY2(int $offsetY2) : self
Parameters
$offsetY2 : int
Return values
self

setResizeProportional()

public setResizeProportional(bool $resizeProportional) : self
Parameters
$resizeProportional : bool
Return values
self

setRotation()

public setRotation(int $rotation) : self
Parameters
$rotation : int
Return values
self

setShadow()

public setShadow([Shadow|null $shadow = null ]) : self
Parameters
$shadow : Shadow|null = null
Return values
self

setWidth()

public setWidth(int $width) : self
Parameters
$width : int
Return values
self

setWidthAndHeight()

Set width and height with proportional resize.

public setWidthAndHeight(int $width, int $height) : self

Example: $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120);

Parameters
$width : int
$height : int
Tags
author

Vincent@luo MSN:kele_100@hotmail.com

Return values
self

setWorksheet()

Set Worksheet.

public setWorksheet([Worksheet|null $worksheet = null ][, bool $overrideOld = false ]) : self
Parameters
$worksheet : Worksheet|null = null
$overrideOld : bool = false

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

Return values
self

validEditAs()

public validEditAs() : bool
Return values
bool

setSizesAndType()

Set Fact Sizes and Type of Image.

protected setSizesAndType(string $path) : void
Parameters
$path : string
Return values
void

Search results