Documentation

HeaderFooterDrawing extends Drawing

in package

• Application

Table of Contents

Constants

EDIT_AS_ABSOLUTE  = 'absolute'

EDIT_AS_ONECELL  = 'oneCell'

EDIT_AS_TWOCELL  = 'twoCell'

IMAGE_TYPES_CONVERTION_MAP  = [IMAGETYPE_GIF => IMAGETYPE_PNG, IMAGETYPE_JPEG => IMAGETYPE_JPEG, IMAGETYPE_PNG => IMAGETYPE_PNG, IMAGETYPE_BMP => IMAGETYPE_PNG]

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

Properties

$coordinates  : string

Coordinates.

$coordinates2  : string

Coordinates2.

$description  : string

Description.

$editAs  : string

The editAs attribute, used only with two cell anchor.

$flipHorizontal  : bool

$flipVertical  : bool

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

$opacity  : int|null

Percentage multiplied by 100,000, e.g. 40% = 40,000.

$resizeProportional  : bool

Proportional resize.

$rotation  : int

Rotation.

$shadow  : Shadow

Shadow.

$srcRect  : null|SimpleXMLElement|array<string|int, string>

$type  : int

Image type.

$width  : int

Width.

$worksheet  : Worksheet|null

Worksheet.

$hyperlink  : Hyperlink|null

Image hyperlink.

$imageCounter  : int

Image counter.

$imageIndex  : int

Image index.

$isUrl  : bool

Whether or not we are dealing with a URL.

$path  : string

Path.

Methods

__clone()  : mixed

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

__construct()  : mixed

Create a new Drawing.

__destruct()  : mixed

getCoordinates()  : string

getCoordinates2()  : string

getDescription()  : string

getEditAs()  : string

getExtension()  : string

Get Extension.

getFilename()  : string

Get Filename.

getFlipHorizontal()  : bool

getFlipVertical()  : bool

getHashCode()  : string

Get hash code.

getHeight()  : int

getHyperlink()  : Hyperlink|null

getImageFileExtensionForSave()  : string

Get Image file extention for Save.

getImageHeight()  : int

getImageIndex()  : int

getImageMimeType()  : string

Get Image mime type.

getImageTypeForSave()  : int

Get Image Type for Save.

getImageWidth()  : int

getIndexedFilename()  : string

Get indexed filename (using image index).

getIsURL()  : bool

Get isURL.

getMediaFilename()  : string

Get full filepath to store drawing in zip archive.

getName()  : string

getOffsetX()  : int

getOffsetX2()  : int

getOffsetY()  : int

getOffsetY2()  : int

getOpacity()  : int|null

getPath()  : string

Get Path.

getResizeProportional()  : bool

getRotation()  : int

getShadow()  : Shadow

getSrcRect()  : null|SimpleXMLElement|array<string|int, string>

getType()  : int

Get Image Type.

getWidth()  : int

getWorksheet()  : Worksheet|null

setCoordinates()  : self

setCoordinates2()  : self

setDescription()  : self

setEditAs()  : self

setFlipHorizontal()  : self

setFlipVertical()  : self

setHeight()  : self

setHyperlink()  : void

setIsURL()  : $this

Set isURL.

setName()  : self

setOffsetX()  : self

setOffsetX2()  : self

setOffsetY()  : self

setOffsetY2()  : self

setOpacity()  : self

setPath()  : $this

Set Path.

setResizeProportional()  : self

setRotation()  : self

setShadow()  : self

setSrcRect()  : 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.

isImage()  : bool