class SpContainer (View source)

Methods

setParent(SpgrContainer $parent)

Set parent Shape Group Container.

getParent()

Get the parent Shape Group Container.

setSpgr(bool $value)

Set whether this is a group shape.

bool
getSpgr()

Get whether this is a group shape.

setSpType(int $value)

Set the shape type.

int
getSpType()

Get the shape type.

setSpFlag(int $value)

Set the shape flag.

int
getSpFlag()

Get the shape flag.

setSpId(int $value)

Set the shape index.

int
getSpId()

Get the shape index.

setOPT(int $property, mixed $value)

Set an option for the Shape Group Container.

mixed
getOPT(int $property)

Get an option for the Shape Group Container.

array
getOPTCollection()

Get the collection of options.

setStartCoordinates(string $value)

Set cell coordinates of upper-left corner of shape.

string
getStartCoordinates()

Get cell coordinates of upper-left corner of shape.

setStartOffsetX(int $startOffsetX)

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

int
getStartOffsetX()

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

setStartOffsetY(int $startOffsetY)

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

int
getStartOffsetY()

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

setEndCoordinates(string $value)

Set cell coordinates of bottom-right corner of shape.

string
getEndCoordinates()

Get cell coordinates of bottom-right corner of shape.

setEndOffsetX(int $endOffsetX)

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

int
getEndOffsetX()

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

setEndOffsetY(int $endOffsetY)

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

int
getEndOffsetY()

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

int
getNestingLevel()

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.

Details

setParent(SpgrContainer $parent)

Set parent Shape Group Container.

Parameters

SpgrContainer $parent

SpgrContainer getParent()

Get the parent Shape Group Container.

Return Value

SpgrContainer

setSpgr(bool $value)

Set whether this is a group shape.

Parameters

bool $value

bool getSpgr()

Get whether this is a group shape.

Return Value

bool

setSpType(int $value)

Set the shape type.

Parameters

int $value

int getSpType()

Get the shape type.

Return Value

int

setSpFlag(int $value)

Set the shape flag.

Parameters

int $value

int getSpFlag()

Get the shape flag.

Return Value

int

setSpId(int $value)

Set the shape index.

Parameters

int $value

int getSpId()

Get the shape index.

Return Value

int

setOPT(int $property, mixed $value)

Set an option for the Shape Group Container.

Parameters

int $property The number specifies the option
mixed $value

mixed getOPT(int $property)

Get an option for the Shape Group Container.

Parameters

int $property The number specifies the option

Return Value

mixed

array getOPTCollection()

Get the collection of options.

Return Value

array

setStartCoordinates(string $value)

Set cell coordinates of upper-left corner of shape.

Parameters

string $value eg: 'A1'

string getStartCoordinates()

Get cell coordinates of upper-left corner of shape.

Return Value

string

setStartOffsetX(int $startOffsetX)

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

Parameters

int $startOffsetX

int getStartOffsetX()

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

Return Value

int

setStartOffsetY(int $startOffsetY)

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

Parameters

int $startOffsetY

int getStartOffsetY()

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

Return Value

int

setEndCoordinates(string $value)

Set cell coordinates of bottom-right corner of shape.

Parameters

string $value eg: 'A1'

string getEndCoordinates()

Get cell coordinates of bottom-right corner of shape.

Return Value

string

setEndOffsetX(int $endOffsetX)

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

Parameters

int $endOffsetX

int getEndOffsetX()

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

Return Value

int

setEndOffsetY(int $endOffsetY)

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

Parameters

int $endOffsetY

int getEndOffsetY()

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

Return Value

int

int getNestingLevel()

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.

Return Value

int Nesting level