Documentation

RowDimension extends Dimension
in package

Table of Contents

Properties

$collapsed  : bool
Collapsed.
$height  : float
Row height (in pt).
$outlineLevel  : int
Outline level.
$rowIndex  : int|null
Row index.
$visible  : bool
Visible?
$xfIndex  : int|null
Index to cellXf. Null value means row has no explicit cellXf format.
$zeroHeight  : bool
ZeroHeight for Row?

Methods

__construct()  : mixed
Create a new RowDimension.
getCollapsed()  : bool
Get Collapsed.
getOutlineLevel()  : int
Get Outline Level.
getRowHeight()  : float
Get Row Height.
getRowIndex()  : int|null
Get Row Index.
getVisible()  : bool
Get Visible.
getXfIndex()  : int|null
Get index to cellXf.
getZeroHeight()  : bool
Get ZeroHeight.
setCollapsed()  : $this
Set Collapsed.
setOutlineLevel()  : $this
Set Outline Level.
setRowHeight()  : $this
Set Row Height.
setRowIndex()  : $this
Set Row Index.
setVisible()  : $this
Set Visible.
setXfIndex()  : $this
Set index to cellXf.
setZeroHeight()  : $this
Set ZeroHeight.

Properties

$collapsed

Collapsed.

private bool $collapsed = false

$height

Row height (in pt).

private float $height = -1

When this is set to a negative value, the row height should be ignored by IWriter

$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

$zeroHeight

ZeroHeight for Row?

private bool $zeroHeight = false

Methods

__construct()

Create a new RowDimension.

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

Numeric row index

getCollapsed()

Get Collapsed.

public getCollapsed() : bool
Return values
bool

getOutlineLevel()

Get Outline Level.

public getOutlineLevel() : int
Return values
int

getRowHeight()

Get Row Height.

public getRowHeight([string|null $unitOfMeasure = null ]) : float

By default, this will be in points; but this method also accepts an optional unit of measure argument, and will convert the value from points to the specified UoM. A value of -1 tells Excel to display this column in its default height.

Parameters
$unitOfMeasure : string|null = null
Return values
float

getRowIndex()

Get Row Index.

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

getVisible()

Get Visible.

public getVisible() : bool
Return values
bool

getXfIndex()

Get index to cellXf.

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

getZeroHeight()

Get ZeroHeight.

public getZeroHeight() : bool
Return values
bool

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

setRowHeight()

Set Row Height.

public setRowHeight(float $height[, string|null $unitOfMeasure = null ]) : $this
Parameters
$height : float

in points. A value of -1 tells Excel to display this column in its default height. By default, this will be the passed argument value; but this method also accepts an optional unit of measure argument, and will convert the passed argument value to points from the specified UoM

$unitOfMeasure : string|null = null
Return values
$this

setRowIndex()

Set Row Index.

public setRowIndex(int $index) : $this
Parameters
$index : 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

setZeroHeight()

Set ZeroHeight.

public setZeroHeight(bool $zeroHeight) : $this
Parameters
$zeroHeight : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results