\PhpOffice\PhpSpreadsheet\WorksheetDimension

Summary

Methods
Properties
Constants
__construct()
getVisible()
setVisible()
getOutlineLevel()
setOutlineLevel()
getCollapsed()
setCollapsed()
getXfIndex()
setXfIndex()
__clone()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$visible
$outlineLevel
$collapsed
$xfIndex
N/A

Properties

$visible

$visible : boolean

Visible?

Type

boolean

$outlineLevel

$outlineLevel : integer

Outline level.

Type

integer

$collapsed

$collapsed : boolean

Collapsed.

Type

boolean

$xfIndex

$xfIndex : null|integer

Index to cellXf. Null value means row has no explicit cellXf format.

Type

null|integer

Methods

__construct()

__construct(integer  $initialValue = null) 

Create a new Dimension.

Parameters

integer $initialValue

Numeric row index

getVisible()

getVisible() : boolean

Get Visible.

Returns

boolean

setVisible()

setVisible(boolean  $pValue) : $this

Set Visible.

Parameters

boolean $pValue

Returns

$this

getOutlineLevel()

getOutlineLevel() : integer

Get Outline Level.

Returns

integer

setOutlineLevel()

setOutlineLevel(integer  $pValue) : $this

Set Outline Level.

Value must be between 0 and 7.

Parameters

integer $pValue

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getCollapsed()

getCollapsed() : boolean

Get Collapsed.

Returns

boolean

setCollapsed()

setCollapsed(boolean  $pValue) : $this

Set Collapsed.

Parameters

boolean $pValue

Returns

$this

getXfIndex()

getXfIndex() : integer

Get index to cellXf.

Returns

integer

setXfIndex()

setXfIndex(integer  $pValue) : $this

Set index to cellXf.

Parameters

integer $pValue

Returns

$this

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.