Collaboration diagram for PHPExcel_Worksheet_RowDimension:

Public Member Functions
	__construct ($pIndex=0)
	Create a new PHPExcel_Worksheet_RowDimension. More...

	getRowIndex ()
	Get Row Index. More...

	setRowIndex ($pValue)
	Set Row Index. More...

	getRowHeight ()
	Get Row Height. More...

	setRowHeight ($pValue=-1)
	Set Row Height. More...

	getZeroHeight ()
	Get ZeroHeight. More...

	setZeroHeight ($pValue=false)
	Set ZeroHeight. More...

	getVisible ()
	Get Visible. More...

	setVisible ($pValue=true)
	Set Visible. More...

	getOutlineLevel ()
	Get Outline Level. More...

	setOutlineLevel ($pValue)
	Set Outline Level. More...

	getCollapsed ()
	Get Collapsed. More...

	setCollapsed ($pValue=true)
	Set Collapsed. More...

	getXfIndex ()
	Get index to cellXf. More...

	setXfIndex ($pValue=0)
	Set index to cellXf. More...

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

Private Attributes
	$_rowIndex

	$_rowHeight = -1

	$_zeroHeight = false

	$_visible = true

	$_outlineLevel = 0

	$_collapsed = false

	$_xfIndex

Detailed Description

Definition at line 36 of file RowDimension.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Worksheet_RowDimension::__construct ( $pIndex = 0 )

Create a new PHPExcel_Worksheet_RowDimension.

Parameters

int $pIndex Numeric row index

Definition at line 94 of file RowDimension.php.

     {
         // Initialise values
         $this->_rowIndex                = $pIndex;
 
                 // set row dimension as unformatted by default
                 $this->_xfIndex = null;
     }

Member Function Documentation

◆ __clone()

PHPExcel_Worksheet_RowDimension::__clone ( )

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

Definition at line 255 of file RowDimension.php.

                                   {
                 $vars = get_object_vars($this);
                 foreach ($vars as $key => $value) {
                         if (is_object($value)) {
                                 $this->$key = clone $value;
                         } else {
                                 $this->$key = $value;
                         }
                 }
         }

◆ getCollapsed()

PHPExcel_Worksheet_RowDimension::getCollapsed ( )

Get Collapsed.

Returns: bool

Definition at line 215 of file RowDimension.php.

References $_collapsed.

                                    {
         return $this->_collapsed;
     }

◆ getOutlineLevel()

PHPExcel_Worksheet_RowDimension::getOutlineLevel ( )

Get Outline Level.

Returns: int

Definition at line 188 of file RowDimension.php.

References $_outlineLevel.

                                       {
         return $this->_outlineLevel;
     }

◆ getRowHeight()

PHPExcel_Worksheet_RowDimension::getRowHeight ( )

Get Row Height.

Returns: double

Definition at line 128 of file RowDimension.php.

References $_rowHeight.

                                    {
         return $this->_rowHeight;
     }

◆ getRowIndex()

PHPExcel_Worksheet_RowDimension::getRowIndex ( )

Get Row Index.

Returns: int

Definition at line 108 of file RowDimension.php.

References $_rowIndex.

                                   {
         return $this->_rowIndex;
     }

◆ getVisible()

PHPExcel_Worksheet_RowDimension::getVisible ( )

Get Visible.

Returns: bool

Definition at line 168 of file RowDimension.php.

References $_visible.

                                  {
         return $this->_visible;
     }

◆ getXfIndex()

PHPExcel_Worksheet_RowDimension::getXfIndex ( )

Get index to cellXf.

Returns: int

Definition at line 235 of file RowDimension.php.

References $_xfIndex.

         {
                 return $this->_xfIndex;
         }

◆ getZeroHeight()

PHPExcel_Worksheet_RowDimension::getZeroHeight ( )

Get ZeroHeight.

Returns: bool

Definition at line 148 of file RowDimension.php.

References $_zeroHeight.

                                         {
                 return $this->_zeroHeight;
         }

◆ setCollapsed()

PHPExcel_Worksheet_RowDimension::setCollapsed ( $pValue = true )

Set Collapsed.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 225 of file RowDimension.php.

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

◆ setOutlineLevel()

PHPExcel_Worksheet_RowDimension::setOutlineLevel ( $pValue )

Set Outline Level.

Value must be between 0 and 7

Parameters

int $pValue

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 201 of file RowDimension.php.

                                              {
         if ($pValue < 0 || $pValue > 7) {
                 throw new PHPExcel_Exception("Outline level must range between 0 and 7.");
         }
 
         $this->_outlineLevel = $pValue;
         return $this;
     }

◆ setRowHeight()

PHPExcel_Worksheet_RowDimension::setRowHeight ( $pValue = -1 )

Set Row Height.

Parameters

double $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 138 of file RowDimension.php.

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

◆ setRowIndex()

PHPExcel_Worksheet_RowDimension::setRowIndex ( $pValue )

Set Row Index.

Parameters

int $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 118 of file RowDimension.php.

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

◆ setVisible()

PHPExcel_Worksheet_RowDimension::setVisible ( $pValue = true )

Set Visible.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 178 of file RowDimension.php.

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

◆ setXfIndex()

PHPExcel_Worksheet_RowDimension::setXfIndex ( $pValue = 0 )

Set index to cellXf.

Parameters

int $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 246 of file RowDimension.php.

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

◆ setZeroHeight()

PHPExcel_Worksheet_RowDimension::setZeroHeight ( $pValue = false )

Set ZeroHeight.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_RowDimension

Definition at line 158 of file RowDimension.php.

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

Field Documentation

◆ $_collapsed

PHPExcel_Worksheet_RowDimension::$_collapsed = false

private

Definition at line 80 of file RowDimension.php.

Referenced by getCollapsed().

◆ $_outlineLevel

PHPExcel_Worksheet_RowDimension::$_outlineLevel = 0

private

Definition at line 73 of file RowDimension.php.

Referenced by getOutlineLevel().

◆ $_rowHeight

PHPExcel_Worksheet_RowDimension::$_rowHeight = -1

private

Definition at line 52 of file RowDimension.php.

Referenced by getRowHeight().

◆ $_rowIndex

PHPExcel_Worksheet_RowDimension::$_rowIndex

private

Definition at line 43 of file RowDimension.php.

Referenced by getRowIndex().

◆ $_visible

PHPExcel_Worksheet_RowDimension::$_visible = true

private

Definition at line 66 of file RowDimension.php.

Referenced by getVisible().

◆ $_xfIndex

PHPExcel_Worksheet_RowDimension::$_xfIndex

private

Definition at line 87 of file RowDimension.php.

Referenced by getXfIndex().

◆ $_zeroHeight

PHPExcel_Worksheet_RowDimension::$_zeroHeight = false

private

Definition at line 59 of file RowDimension.php.

Referenced by getZeroHeight().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/RowDimension.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getCollapsed()

◆ getOutlineLevel()

◆ getRowHeight()

◆ getRowIndex()

◆ getVisible()

◆ getXfIndex()

◆ getZeroHeight()

◆ setCollapsed()

◆ setOutlineLevel()

◆ setRowHeight()

◆ setRowIndex()

◆ setVisible()

◆ setXfIndex()

◆ setZeroHeight()

Field Documentation

◆ $_collapsed

◆ $_outlineLevel

◆ $_rowHeight

◆ $_rowIndex

◆ $_visible

◆ $_xfIndex

◆ $_zeroHeight