PhpOffice\PhpSpreadsheet\Worksheet\RowDimension Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\RowDimension:

Public Member Functions
	__construct (?int $index=0)
	Create a new RowDimension.
	getCollapsed ()
	Get Collapsed.
	getOutlineLevel ()
	Get Outline Level.
	getRowHeight (?string $unitOfMeasure=null)
	Get Row Height.
	getRowIndex ()
	Get Row Index.
	getVisible ()
	Get Visible.
	getXfIndex ()
	Get index to cellXf.
	getZeroHeight ()
	Get ZeroHeight.
	setCollapsed (bool $collapsed)
	Set Collapsed.
	setOutlineLevel (int $level)
	Set Outline Level.
	setRowHeight (float $height, ?string $unitOfMeasure=null)
	Set Row Height.
	setRowIndex (int $index)
	Set Row Index.
	setVisible (bool $visible)
	Set Visible.
	setXfIndex (int $XfIndex)
	Set index to cellXf.
	setZeroHeight (bool $zeroHeight)
	Set ZeroHeight.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::__construct

(

?int

$index = 0

)

Create a new RowDimension.

Parameters

?int

$index

Numeric row index

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Dimension.

Member Function Documentation

getRowHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::getRowHeight

(

?string

$unitOfMeasure = null

)

Get Row Height.

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.

setCollapsed()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setCollapsed ( bool $collapsed )

inherited

Set Collapsed.

Return values

$this

setOutlineLevel()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setOutlineLevel ( int $level )

inherited

Set Outline Level.

Value must be between 0 and 7.

Return values

$this

setRowHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setRowHeight	(	float	$height,
		?string	$unitOfMeasure = null )

Set Row Height.

Parameters

float

$height

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

Return values

$this

setRowIndex()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setRowIndex

(

int

$index

)

Set Row Index.

Return values

$this

setVisible()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setVisible ( bool $visible )

inherited

Set Visible.

Return values

$this

setXfIndex()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setXfIndex ( int $XfIndex )

inherited

Set index to cellXf.

Return values

$this

setZeroHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setZeroHeight

(

bool

$zeroHeight

)

Set ZeroHeight.

Return values

$this

---

The documentation for this class was generated from the following file:

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Worksheet/RowDimension.php