Gitee
\
app
index
controller
model
validate
org
Org
tests
think
cache
driver
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
log
driver
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think

\PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
setParent()
getParent()
setSpgr()
getSpgr()
setSpType()
getSpType()
setSpFlag()
getSpFlag()
setSpId()
getSpId()
setOPT()
getOPT()
getOPTCollection()
setStartCoordinates()
getStartCoordinates()
setStartOffsetX()
getStartOffsetX()
setStartOffsetY()
getStartOffsetY()
setEndCoordinates()
getEndCoordinates()
setEndOffsetX()
getEndOffsetX()
setEndOffsetY()
getEndOffsetY()
getNestingLevel()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$parent
$spgr
$spType
$spFlag
$spId
$OPT
$startCoordinates
$startOffsetX
$startOffsetY
$endCoordinates
$endOffsetX
$endOffsetY
N/A

Properties

$spgr

$spgr : boolean

Is this a group shape?

Type

boolean

$spType

$spType : integer

Shape type

Type

integer

$spFlag

$spFlag : integer

Shape flag

Type

integer

$spId

$spId : boolean

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

..)

Type

boolean

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

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

Type

integer

$startOffsetY

$startOffsetY : integer

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

Type

integer

$endCoordinates

$endCoordinates : string

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

Type

string

$endOffsetX

$endOffsetX : integer

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

Type

integer

$endOffsetY

$endOffsetY : integer

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

Type

integer

Methods

setSpgr()

setSpgr(boolean  $value = false)

Set whether this is a group shape

Parameters

boolean $value

getSpgr()

getSpgr() : boolean

Get whether this is a group shape

Returns

boolean

setSpType()

setSpType(integer  $value)

Set the shape type

Parameters

integer $value

getSpType()

getSpType() : integer

Get the shape type

Returns

integer

setSpFlag()

setSpFlag(integer  $value)

Set the shape flag

Parameters

integer $value

getSpFlag()

getSpFlag() : integer

Get the shape flag

Returns

integer

setSpId()

setSpId(integer  $value)

Set the shape index

Parameters

integer $value

getSpId()

getSpId() : integer

Get the shape index

Returns

integer

setOPT()

setOPT(integer  $property, mixed  $value)

Set an option for the Shape Group Container

Parameters

integer $property

The number specifies the option
mixed $value

getOPT()

getOPT(integer  $property) : mixed

Get an option for the Shape Group Container

Parameters

integer $property

The number specifies the option

Returns

mixed

getOPTCollection()

getOPTCollection() : array

Get the collection of options

Returns

array

setStartCoordinates()

setStartCoordinates(string  $value = 'A1')

Set cell coordinates of upper-left corner of shape

Parameters

string $value

getStartCoordinates()

getStartCoordinates() : string

Get cell coordinates of upper-left corner of shape

Returns

string

setStartOffsetX()

setStartOffsetX(integer  $startOffsetX)

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

Parameters

integer $startOffsetX

getStartOffsetX()

getStartOffsetX() : integer

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

Returns

integer

setStartOffsetY()

setStartOffsetY(integer  $startOffsetY)

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

Parameters

integer $startOffsetY

getStartOffsetY()

getStartOffsetY() : integer

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

Returns

integer

setEndCoordinates()

setEndCoordinates(string  $value = 'A1')

Set cell coordinates of bottom-right corner of shape

Parameters

string $value

getEndCoordinates()

getEndCoordinates() : string

Get cell coordinates of bottom-right corner of shape

Returns

string

setEndOffsetX()

setEndOffsetX(  $endOffsetX)

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

Parameters

$endOffsetX

getEndOffsetX()

getEndOffsetX() : integer

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

Returns

integer

setEndOffsetY()

setEndOffsetY(integer  $endOffsetY)

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

Parameters

integer $endOffsetY

getEndOffsetY()

getEndOffsetY() : integer

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

Returns

integer

getNestingLevel()

getNestingLevel() : integer

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

integer —

Nesting level