Documentation

SpContainer
in package

Table of Contents

Properties

$endCoordinates  : string
Cell coordinates of bottom-right corner of shape, e.g. 'B2'.
$endOffsetX  : int|float
Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width.
$endOffsetY  : int|float
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|float
Horizontal offset of upper-left corner of shape measured in 1/1024 of column width.
$startOffsetY  : int|float
Vertical offset of upper-left corner of shape measured in 1/256 of row height.

Methods

getEndCoordinates()  : string
Get cell coordinates of bottom-right corner of shape.
getEndOffsetX()  : int|float
Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.
getEndOffsetY()  : int|float
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|float
Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.
getStartOffsetY()  : int|float
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|float $endOffsetX

$endOffsetY

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

private int|float $endOffsetY

$OPT

Array of options.

private array<string|int, mixed> $OPT = []

$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

$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|float $startOffsetX

$startOffsetY

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

private int|float $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|float
Return values
int|float

getEndOffsetY()

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

public getEndOffsetY() : int|float
Return values
int|float

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

getOPTCollection()

Get the collection of options.

public getOPTCollection() : array<string|int, mixed>
Return values
array<string|int, mixed>

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|float
Return values
int|float

getStartOffsetY()

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

public getStartOffsetY() : int|float
Return values
int|float

setEndCoordinates()

Set cell coordinates of bottom-right corner of shape.

public setEndCoordinates(string $value) : void
Parameters
$value : string

eg: 'A1'

setEndOffsetX()

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

public setEndOffsetX(int|float $endOffsetX) : void
Parameters
$endOffsetX : int|float

setEndOffsetY()

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

public setEndOffsetY(int|float $endOffsetY) : void
Parameters
$endOffsetY : int|float

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

setSpFlag()

Set the shape flag.

public setSpFlag(int $value) : void
Parameters
$value : int

setSpgr()

Set whether this is a group shape.

public setSpgr(bool $value) : void
Parameters
$value : bool

setSpId()

Set the shape index.

public setSpId(int $value) : void
Parameters
$value : int

setSpType()

Set the shape type.

public setSpType(int $value) : void
Parameters
$value : int

setStartCoordinates()

Set cell coordinates of upper-left corner of shape.

public setStartCoordinates(string $value) : void
Parameters
$value : string

eg: 'A1'

setStartOffsetX()

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

public setStartOffsetX(int|float $startOffsetX) : void
Parameters
$startOffsetX : int|float

setStartOffsetY()

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

public setStartOffsetY(int|float $startOffsetY) : void
Parameters
$startOffsetY : int|float 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results