Collaboration diagram for PHPExcel_Worksheet_ColumnDimension:

Public Member Functions
	__construct ($pIndex='A')
	Create a new PHPExcel_Worksheet_ColumnDimension. More...

	getColumnIndex ()
	Get ColumnIndex. More...

	setColumnIndex ($pValue)
	Set ColumnIndex. More...

	getWidth ()
	Get Width. More...

	setWidth ($pValue=-1)
	Set Width. More...

	getAutoSize ()
	Get Auto Size. More...

	setAutoSize ($pValue=false)
	Set Auto Size. 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
	$_columnIndex

	$_width = -1

	$_autoSize = false

	$_visible = true

	$_outlineLevel = 0

	$_collapsed = false

	$_xfIndex

Detailed Description

Definition at line 36 of file ColumnDimension.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Worksheet_ColumnDimension::__construct ( $pIndex = 'A' )

Create a new PHPExcel_Worksheet_ColumnDimension.

Parameters

string $pIndex Character column index

Definition at line 94 of file ColumnDimension.php.

     {
         // Initialise values
         $this->_columnIndex             = $pIndex;
 
                 // set default index to cellXf
                 $this->_xfIndex = 0;
     }

Member Function Documentation

◆ __clone()

PHPExcel_Worksheet_ColumnDimension::__clone ( )

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

Definition at line 255 of file ColumnDimension.php.

References $key.

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

◆ getAutoSize()

PHPExcel_Worksheet_ColumnDimension::getAutoSize ( )

Get Auto Size.

Returns: bool

Definition at line 148 of file ColumnDimension.php.

References $_autoSize.

                                   {
         return $this->_autoSize;
     }

◆ getCollapsed()

PHPExcel_Worksheet_ColumnDimension::getCollapsed ( )

Get Collapsed.

Returns: bool

Definition at line 215 of file ColumnDimension.php.

References $_collapsed.

                                    {
         return $this->_collapsed;
     }

◆ getColumnIndex()

PHPExcel_Worksheet_ColumnDimension::getColumnIndex ( )

Get ColumnIndex.

Returns: string

Definition at line 108 of file ColumnDimension.php.

References $_columnIndex.

                                      {
         return $this->_columnIndex;
     }

◆ getOutlineLevel()

PHPExcel_Worksheet_ColumnDimension::getOutlineLevel ( )

Get Outline Level.

Returns: int

Definition at line 188 of file ColumnDimension.php.

References $_outlineLevel.

                                       {
         return $this->_outlineLevel;
     }

◆ getVisible()

PHPExcel_Worksheet_ColumnDimension::getVisible ( )

Get Visible.

Returns: bool

Definition at line 168 of file ColumnDimension.php.

References $_visible.

                                  {
         return $this->_visible;
     }

◆ getWidth()

PHPExcel_Worksheet_ColumnDimension::getWidth ( )

Get Width.

Returns: double

Definition at line 128 of file ColumnDimension.php.

References $_width.

                                {
         return $this->_width;
     }

◆ getXfIndex()

PHPExcel_Worksheet_ColumnDimension::getXfIndex ( )

Get index to cellXf.

Returns: int

Definition at line 235 of file ColumnDimension.php.

References $_xfIndex.

         {
                 return $this->_xfIndex;
         }

◆ setAutoSize()

PHPExcel_Worksheet_ColumnDimension::setAutoSize ( $pValue = false )

Set Auto Size.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 158 of file ColumnDimension.php.

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

◆ setCollapsed()

PHPExcel_Worksheet_ColumnDimension::setCollapsed ( $pValue = true )

Set Collapsed.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 225 of file ColumnDimension.php.

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

◆ setColumnIndex()

PHPExcel_Worksheet_ColumnDimension::setColumnIndex ( $pValue )

Set ColumnIndex.

Parameters

string $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 118 of file ColumnDimension.php.

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

◆ setOutlineLevel()

PHPExcel_Worksheet_ColumnDimension::setOutlineLevel ( $pValue )

Set Outline Level.

Value must be between 0 and 7

Parameters

int $pValue

Exceptions

PHPExcel_Exception

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 201 of file ColumnDimension.php.

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

◆ setVisible()

PHPExcel_Worksheet_ColumnDimension::setVisible ( $pValue = true )

Set Visible.

Parameters

bool $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 178 of file ColumnDimension.php.

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

◆ setWidth()

PHPExcel_Worksheet_ColumnDimension::setWidth ( $pValue = -1 )

Set Width.

Parameters

double $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 138 of file ColumnDimension.php.

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

◆ setXfIndex()

PHPExcel_Worksheet_ColumnDimension::setXfIndex ( $pValue = 0 )

Set index to cellXf.

Parameters

int $pValue

Returns: PHPExcel_Worksheet_ColumnDimension

Definition at line 246 of file ColumnDimension.php.

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

Field Documentation

◆ $_autoSize

PHPExcel_Worksheet_ColumnDimension::$_autoSize = false

private

Definition at line 59 of file ColumnDimension.php.

Referenced by getAutoSize().

◆ $_collapsed

PHPExcel_Worksheet_ColumnDimension::$_collapsed = false

private

Definition at line 80 of file ColumnDimension.php.

Referenced by getCollapsed().

◆ $_columnIndex

PHPExcel_Worksheet_ColumnDimension::$_columnIndex

private

Definition at line 43 of file ColumnDimension.php.

Referenced by getColumnIndex().

◆ $_outlineLevel

PHPExcel_Worksheet_ColumnDimension::$_outlineLevel = 0

private

Definition at line 73 of file ColumnDimension.php.

Referenced by getOutlineLevel().

◆ $_visible

PHPExcel_Worksheet_ColumnDimension::$_visible = true

private

Definition at line 66 of file ColumnDimension.php.

Referenced by getVisible().

◆ $_width

PHPExcel_Worksheet_ColumnDimension::$_width = -1

private

Definition at line 52 of file ColumnDimension.php.

Referenced by getWidth().

◆ $_xfIndex

PHPExcel_Worksheet_ColumnDimension::$_xfIndex

private

Definition at line 87 of file ColumnDimension.php.

Referenced by getXfIndex().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getAutoSize()

◆ getCollapsed()

◆ getColumnIndex()

◆ getOutlineLevel()

◆ getVisible()

◆ getWidth()

◆ getXfIndex()

◆ setAutoSize()

◆ setCollapsed()

◆ setColumnIndex()

◆ setOutlineLevel()

◆ setVisible()

◆ setWidth()

◆ setXfIndex()

Field Documentation

◆ $_autoSize

◆ $_collapsed

◆ $_columnIndex

◆ $_outlineLevel

◆ $_visible

◆ $_width

◆ $_xfIndex