Documentation

Dimension
in package

AbstractYes

Table of Contents

Properties

$collapsed  : bool
Collapsed.
$outlineLevel  : int
Outline level.
$visible  : bool
Visible?
$xfIndex  : int|null
Index to cellXf. Null value means row has no explicit cellXf format.

Methods

__construct()  : mixed
Create a new Dimension.
getCollapsed()  : bool
Get Collapsed.
getOutlineLevel()  : int
Get Outline Level.
getVisible()  : bool
Get Visible.
getXfIndex()  : int|null
Get index to cellXf.
setCollapsed()  : $this
Set Collapsed.
setOutlineLevel()  : $this
Set Outline Level.
setVisible()  : $this
Set Visible.
setXfIndex()  : $this
Set index to cellXf.

Properties

$collapsed

Collapsed.

private bool $collapsed = false

$outlineLevel

Outline level.

private int $outlineLevel = 0

$visible

Visible?

private bool $visible = true

$xfIndex

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

private int|null $xfIndex

Methods

__construct()

Create a new Dimension.

public __construct([int|null $initialValue = null ]) : mixed
Parameters
$initialValue : int|null = null

Numeric row index

getCollapsed()

Get Collapsed.

public getCollapsed() : bool
Return values
bool

getOutlineLevel()

Get Outline Level.

public getOutlineLevel() : int
Return values
int

getVisible()

Get Visible.

public getVisible() : bool
Return values
bool

getXfIndex()

Get index to cellXf.

public getXfIndex() : int|null
Return values
int|null

setCollapsed()

Set Collapsed.

public setCollapsed(bool $collapsed) : $this
Parameters
$collapsed : bool
Return values
$this

setOutlineLevel()

Set Outline Level.

public setOutlineLevel(int $level) : $this

Value must be between 0 and 7.

Parameters
$level : int
Return values
$this

setVisible()

Set Visible.

public setVisible(bool $visible) : $this
Parameters
$visible : bool
Return values
$this

setXfIndex()

Set index to cellXf.

public setXfIndex(int $XfIndex) : $this
Parameters
$XfIndex : int
Return values
$this

        
On this page

Search results