Properties

$parent

$parent : \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer

Parent Shape Group Container.

Type

SpgrContainer

$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 : int

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

Type

int

$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(\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer  $parent) : void

Set parent Shape Group Container.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer $parent

getParent()

getParent() : \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer

Get the parent Shape Group Container.

Returns

\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer —

setSpgr()

setSpgr(bool  $value) : void

Set whether this is a group shape.

Parameters

bool $value

getSpgr()

getSpgr() : bool

Get whether this is a group shape.

Returns

bool —

setSpType()

setSpType(int  $value) : void

Set the shape type.

Parameters

int $value

getSpType()

getSpType() : int

Get the shape type.

Returns

int —

setSpFlag()

setSpFlag(int  $value) : void

Set the shape flag.

Parameters

int $value

getSpFlag()

getSpFlag() : int

Get the shape flag.

Returns

int —

setSpId()

setSpId(int  $value) : void

Set the shape index.

Parameters

int $value

getSpId()

getSpId() : int

Get the shape index.

Returns

int —

setOPT()

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

Set an option for the Shape Group Container.

Parameters

int $property

The number specifies the option

mixed $value

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) : void

Set cell coordinates of upper-left corner of shape.

Parameters

string $value

eg: 'A1'

getStartCoordinates()

getStartCoordinates() : string

Get cell coordinates of upper-left corner of shape.

Returns

string —

setStartOffsetX()

setStartOffsetX(int  $startOffsetX) : void

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

Parameters

int $startOffsetX

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) : void

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

Parameters

int $startOffsetY

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) : void

Set cell coordinates of bottom-right corner of shape.

Parameters

string $value

eg: 'A1'

getEndCoordinates()

getEndCoordinates() : string

Get cell coordinates of bottom-right corner of shape.

Returns

string —

setEndOffsetX()

setEndOffsetX(int  $endOffsetX) : void

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

Parameters

int $endOffsetX

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) : void

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

Parameters

int $endOffsetY

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