PhpOffice\PhpSpreadsheet\Worksheet\RowDimension Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\RowDimension:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\RowDimension:

Public Member Functions
	__construct ($pIndex=0)
	Create a new RowDimension. More...
	getRowIndex ()
	Get Row Index. More...
	setRowIndex (int $index)
	Set Row Index. More...
	getRowHeight ()
	Get Row Height. More...
	setRowHeight ($height)
	Set Row Height. More...
	getZeroHeight ()
	Get ZeroHeight. More...
	setZeroHeight (bool $pValue)
	Set ZeroHeight. More...
Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Worksheet\Dimension
	__construct ($initialValue=null)
	Create a new Dimension. More...
	getVisible ()
	Get Visible. More...
	setVisible (bool $visible)
	Set Visible. More...
	getOutlineLevel ()
	Get Outline Level. More...
	setOutlineLevel (int $level)
	Set Outline Level. More...
	getCollapsed ()
	Get Collapsed. More...
	setCollapsed (bool $collapsed)
	Set Collapsed. More...
	getXfIndex ()
	Get index to cellXf. More...
	setXfIndex (int $pValue)
	Set index to cellXf. More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Private Attributes
	$rowIndex
	$height = -1
	$zeroHeight = false

Detailed Description

Definition at line 5 of file RowDimension.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::__construct

(

$pIndex = 0

)

Create a new RowDimension.

Parameters

int

$pIndex

Numeric row index

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Dimension.

Definition at line 35 of file RowDimension.php.

    {
        // Initialise values
        $this->rowIndex = $pIndex;
 
        // set dimension as unformatted by default
        parent::__construct(null);
    }

Member Function Documentation

getRowHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::getRowHeight

(

)

Get Row Height.

Returns

float

Definition at line 69 of file RowDimension.php.

    {
        return $this->height;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\$height.

getRowIndex()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::getRowIndex

(

)

Get Row Index.

Definition at line 47 of file RowDimension.php.

                                 : int
    {
        return $this->rowIndex;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\$rowIndex.

getZeroHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::getZeroHeight

(

)

Get ZeroHeight.

Definition at line 91 of file RowDimension.php.

                                   : bool
    {
        return $this->zeroHeight;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\$zeroHeight.

setRowHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setRowHeight

(

$height

)

Set Row Height.

Parameters

float

$height

Returns

$this

Definition at line 81 of file RowDimension.php.

    {
        $this->height = $height;
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\$height.

setRowIndex()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setRowIndex

(

int

$index

)

Set Row Index.

Returns

$this

Definition at line 57 of file RowDimension.php.

    {
        $this->rowIndex = $index;
 
        return $this;
    }

References $index.

setZeroHeight()

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::setZeroHeight

(

bool

$pValue

)

Set ZeroHeight.

Returns

$this

Definition at line 101 of file RowDimension.php.

    {
        $this->zeroHeight = $pValue;
 
        return $this;
    }

Field Documentation

$height

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::$height = -1

private

Definition at line 21 of file RowDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\getRowHeight(), and PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\setRowHeight().

$rowIndex

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::$rowIndex

private

Definition at line 12 of file RowDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\getRowIndex().

$zeroHeight

PhpOffice\PhpSpreadsheet\Worksheet\RowDimension::$zeroHeight = false

private

Definition at line 28 of file RowDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\RowDimension\getZeroHeight().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/RowDimension.php