Properties

$_spgr

$_spgr : bool

Is this a group shape?

Type

bool

$_spType

$_spType : int

Shape type

Type

int

$_spFlag

$_spFlag : int

Shape flag

Type

int

$_spId

$_spId : bool

Shape index (usually group shape has index 0, and the rest: 1,2,3...)

Type

bool

$_OPT

$_OPT : array

Array of options

Type

array

$_startCoordinates

$_startCoordinates : string

Cell coordinates of upper-left corner of shape, e.g. 'A1'

Type

string

$_startOffsetX

$_startOffsetX : int

Horizontal offset of upper-left corner of shape measured in 1/1024 of column width

Type

int

$_startOffsetY

$_startOffsetY : int

Vertical offset of upper-left corner of shape measured in 1/256 of row height

Type

int

$_endCoordinates

$_endCoordinates : string

Cell coordinates of bottom-right corner of shape, e.g. 'B2'

Type

string

$_endOffsetX

$_endOffsetX : int

Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width

Type

int

$_endOffsetY

$_endOffsetY : int

Vertical offset of bottom-right corner of shape measured in 1/256 of row height

Type

int

Methods

setParent()

setParent(\PHPExcel_Shared_Escher_DgContainer_SpgrContainer  $parent) : mixed

Set parent Shape Group Container

Parameters

\PHPExcel_Shared_Escher_DgContainer_SpgrContainer $parent

Returns

mixed —

getParent()

getParent() : \PHPExcel_Shared_Escher_DgContainer_SpgrContainer

Get the parent Shape Group Container

Returns

\PHPExcel_Shared_Escher_DgContainer_SpgrContainer —

setSpgr()

setSpgr(bool  $value = false) : mixed

Set whether this is a group shape

Parameters

bool $value

Returns

mixed —

getSpgr()

getSpgr() : bool

Get whether this is a group shape

Returns

bool —

setSpType()

setSpType(int  $value) : mixed

Set the shape type

Parameters

int $value

Returns

mixed —

getSpType()

getSpType() : int

Get the shape type

Returns

int —

setSpFlag()

setSpFlag(int  $value) : mixed

Set the shape flag

Parameters

int $value

Returns

mixed —

getSpFlag()

getSpFlag() : int

Get the shape flag

Returns

int —

setSpId()

setSpId(int  $value) : mixed

Set the shape index

Parameters

int $value

Returns

mixed —

getSpId()

getSpId() : int

Get the shape index

Returns

int —

setOPT()

setOPT(int  $property, mixed  $value) : mixed

Set an option for the Shape Group Container

Parameters

int $property

The number specifies the option

mixed $value

Returns

mixed —

getOPT()

getOPT(int  $property) : mixed

Get an option for the Shape Group Container

Parameters

int $property

The number specifies the option

Returns

mixed —

getOPTCollection()

getOPTCollection() : array

Get the collection of options

Returns

array —

setStartCoordinates()

setStartCoordinates(string  $value = 'A1') : mixed

Set cell coordinates of upper-left corner of shape

Parameters

string $value

Returns

mixed —

getStartCoordinates()

getStartCoordinates() : string

Get cell coordinates of upper-left corner of shape

Returns

string —

setStartOffsetX()

setStartOffsetX(int  $startOffsetX) : mixed

Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width

Parameters

int $startOffsetX

Returns

mixed —

getStartOffsetX()

getStartOffsetX() : int

Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width

Returns

int —

setStartOffsetY()

setStartOffsetY(int  $startOffsetY) : mixed

Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height

Parameters

int $startOffsetY

Returns

mixed —

getStartOffsetY()

getStartOffsetY() : int

Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height

Returns

int —

setEndCoordinates()

setEndCoordinates(string  $value = 'A1') : mixed

Set cell coordinates of bottom-right corner of shape

Parameters

string $value

Returns

mixed —

getEndCoordinates()

getEndCoordinates() : string

Get cell coordinates of bottom-right corner of shape

Returns

string —

setEndOffsetX()

setEndOffsetX(mixed  $endOffsetX) : mixed

Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width

Parameters

mixed $endOffsetX

Returns

mixed —

getEndOffsetX()

getEndOffsetX() : int

Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width

Returns

int —

setEndOffsetY()

setEndOffsetY(int  $endOffsetY) : mixed

Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height

Parameters

int $endOffsetY

Returns

mixed —

getEndOffsetY()

getEndOffsetY() : int

Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height

Returns

int —

getNestingLevel()

getNestingLevel() : int

Get the nesting level of this spContainer. This is the number of spgrContainers between this spContainer and the dgContainer. A value of 1 = immediately within first spgrContainer Higher nesting level occurs if and only if spContainer is part of a shape group

Returns

int —

Nesting level