PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension:

Public Member Functions
	__construct ($pIndex='A')
	Create a new ColumnDimension. More...
	getColumnIndex ()
	Get column index as string eg: 'A'. More...
	setColumnIndex (string $index)
	Set column index as string eg: 'A'. More...
	getWidth ()
	Get Width. More...
	setWidth (float $width)
	Set Width. More...
	getAutoSize ()
	Get Auto Size. More...
	setAutoSize (bool $autosizeEnabled)
	Set Auto Size. 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
	$columnIndex
	$width = -1
	$autoSize = false

Detailed Description

Definition at line 5 of file ColumnDimension.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::__construct

(

$pIndex = 'A'

)

Create a new ColumnDimension.

Parameters

string

$pIndex

Character column index

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Dimension.

Definition at line 35 of file ColumnDimension.php.

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

Member Function Documentation

getAutoSize()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::getAutoSize

(

)

Get Auto Size.

Definition at line 87 of file ColumnDimension.php.

                                 : bool
    {
        return $this->autoSize;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\$autoSize.

getColumnIndex()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::getColumnIndex

(

)

Get column index as string eg: 'A'.

Definition at line 47 of file ColumnDimension.php.

                                    : string
    {
        return $this->columnIndex;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\$columnIndex.

getWidth()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::getWidth

(

)

Get Width.

Definition at line 67 of file ColumnDimension.php.

                              : float
    {
        return $this->width;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\$width.

setAutoSize()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::setAutoSize

(

bool

$autosizeEnabled

)

Set Auto Size.

Returns

$this

Definition at line 97 of file ColumnDimension.php.

    {
        $this->autoSize = $autosizeEnabled;
 
        return $this;
    }

setColumnIndex()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::setColumnIndex

(

string

$index

)

Set column index as string eg: 'A'.

Returns

$this

Definition at line 57 of file ColumnDimension.php.

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

References $index.

setWidth()

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::setWidth

(

float

$width

)

Set Width.

Returns

$this

Definition at line 77 of file ColumnDimension.php.

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

References PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\$width.

Field Documentation

$autoSize

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::$autoSize = false

private

Definition at line 28 of file ColumnDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\getAutoSize().

$columnIndex

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::$columnIndex

private

Definition at line 12 of file ColumnDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\getColumnIndex().

$width

PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension::$width = -1

private

Definition at line 21 of file ColumnDimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\getWidth(), and PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension\setWidth().

---

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

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