SpContainer
Table of Contents
- $endCoordinates : string
- Cell coordinates of bottom-right corner of shape, e.g. 'B2'.
- $endOffsetX : int
- Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width.
- $endOffsetY : int
- Vertical offset of bottom-right corner of shape measured in 1/256 of row height.
- $OPT : array<string|int, mixed>
- Array of options.
- $parent : SpgrContainer
- Parent Shape Group Container.
- $spFlag : int
- Shape flag.
- $spgr : bool
- Is this a group shape?
- $spId : int
- Shape index (usually group shape has index 0, and the rest: 1,2,3...).
- $spType : int
- Shape type.
- $startCoordinates : string
- Cell coordinates of upper-left corner of shape, e.g. 'A1'.
- $startOffsetX : int
- Horizontal offset of upper-left corner of shape measured in 1/1024 of column width.
- $startOffsetY : int
- Vertical offset of upper-left corner of shape measured in 1/256 of row height.
- getEndCoordinates() : string
- Get cell coordinates of bottom-right corner of shape.
- getEndOffsetX() : int
- Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
- getEndOffsetY() : int
- Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
- 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.
- getOPT() : mixed
- Get an option for the Shape Group Container.
- getOPTCollection() : array<string|int, mixed>
- Get the collection of options.
- getParent() : SpgrContainer
- Get the parent Shape Group Container.
- getSpFlag() : int
- Get the shape flag.
- getSpgr() : bool
- Get whether this is a group shape.
- getSpId() : int
- Get the shape index.
- getSpType() : int
- Get the shape type.
- getStartCoordinates() : string
- Get cell coordinates of upper-left corner of shape.
- getStartOffsetX() : int
- Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
- getStartOffsetY() : int
- Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
- setEndCoordinates() : void
- Set cell coordinates of bottom-right corner of shape.
- setEndOffsetX() : void
- Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
- setEndOffsetY() : void
- Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
- setOPT() : void
- Set an option for the Shape Group Container.
- setParent() : void
- Set parent Shape Group Container.
- setSpFlag() : void
- Set the shape flag.
- setSpgr() : void
- Set whether this is a group shape.
- setSpId() : void
- Set the shape index.
- setSpType() : void
- Set the shape type.
- setStartCoordinates() : void
- Set cell coordinates of upper-left corner of shape.
- setStartOffsetX() : void
- Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
- setStartOffsetY() : void
- Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
Properties
$endCoordinates
Cell coordinates of bottom-right corner of shape, e.g. 'B2'.
private
string
$endCoordinates
$endOffsetX
Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width.
private
int
$endOffsetX
$endOffsetY
Vertical offset of bottom-right corner of shape measured in 1/256 of row height.
private
int
$endOffsetY
$OPT
Array of options.
private
array<string|int, mixed>
$OPT
$parent
Parent Shape Group Container.
private
SpgrContainer
$parent
$spFlag
Shape flag.
private
int
$spFlag
$spgr
Is this a group shape?
private
bool
$spgr
= false
$spId
Shape index (usually group shape has index 0, and the rest: 1,2,3...).
private
int
$spId
$spType
Shape type.
private
int
$spType
$startCoordinates
Cell coordinates of upper-left corner of shape, e.g. 'A1'.
private
string
$startCoordinates
$startOffsetX
Horizontal offset of upper-left corner of shape measured in 1/1024 of column width.
private
int
$startOffsetX
$startOffsetY
Vertical offset of upper-left corner of shape measured in 1/256 of row height.
private
int
$startOffsetY
Methods
getEndCoordinates()
Get cell coordinates of bottom-right corner of shape.
public
getEndCoordinates() : string
Return values
string —getEndOffsetX()
Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
public
getEndOffsetX() : int
Return values
int —getEndOffsetY()
Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
public
getEndOffsetY() : int
Return values
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.
public
getNestingLevel() : int
Return values
int —Nesting level
getOPT()
Get an option for the Shape Group Container.
public
getOPT(int $property) : mixed
Parameters
- $property : int
-
The number specifies the option
Return values
mixed —getOPTCollection()
Get the collection of options.
public
getOPTCollection() : array<string|int, mixed>
Return values
array<string|int, mixed> —getParent()
Get the parent Shape Group Container.
public
getParent() : SpgrContainer
Return values
SpgrContainer —getSpFlag()
Get the shape flag.
public
getSpFlag() : int
Return values
int —getSpgr()
Get whether this is a group shape.
public
getSpgr() : bool
Return values
bool —getSpId()
Get the shape index.
public
getSpId() : int
Return values
int —getSpType()
Get the shape type.
public
getSpType() : int
Return values
int —getStartCoordinates()
Get cell coordinates of upper-left corner of shape.
public
getStartCoordinates() : string
Return values
string —getStartOffsetX()
Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
public
getStartOffsetX() : int
Return values
int —getStartOffsetY()
Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
public
getStartOffsetY() : int
Return values
int —setEndCoordinates()
Set cell coordinates of bottom-right corner of shape.
public
setEndCoordinates(string $value) : void
Parameters
- $value : string
-
eg: 'A1'
Return values
void —setEndOffsetX()
Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
public
setEndOffsetX(int $endOffsetX) : void
Parameters
- $endOffsetX : int
Return values
void —setEndOffsetY()
Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.
public
setEndOffsetY(int $endOffsetY) : void
Parameters
- $endOffsetY : int
Return values
void —setOPT()
Set an option for the Shape Group Container.
public
setOPT(int $property, mixed $value) : void
Parameters
- $property : int
-
The number specifies the option
- $value : mixed
Return values
void —setParent()
Set parent Shape Group Container.
public
setParent(SpgrContainer $parent) : void
Parameters
- $parent : SpgrContainer
Return values
void —setSpFlag()
Set the shape flag.
public
setSpFlag(int $value) : void
Parameters
- $value : int
Return values
void —setSpgr()
Set whether this is a group shape.
public
setSpgr(bool $value) : void
Parameters
- $value : bool
Return values
void —setSpId()
Set the shape index.
public
setSpId(int $value) : void
Parameters
- $value : int
Return values
void —setSpType()
Set the shape type.
public
setSpType(int $value) : void
Parameters
- $value : int
Return values
void —setStartCoordinates()
Set cell coordinates of upper-left corner of shape.
public
setStartCoordinates(string $value) : void
Parameters
- $value : string
-
eg: 'A1'
Return values
void —setStartOffsetX()
Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
public
setStartOffsetX(int $startOffsetX) : void
Parameters
- $startOffsetX : int
Return values
void —setStartOffsetY()
Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height.
public
setStartOffsetY(int $startOffsetY) : void
Parameters
- $startOffsetY : int