PhpOffice\PhpSpreadsheet\Worksheet\Dimension Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\Dimension:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\Dimension:

Public Member Functions
	__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
	$visible = true
	$outlineLevel = 0
	$collapsed = false
	$xfIndex

Detailed Description

Definition at line 7 of file Dimension.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::__construct

(

$initialValue = null

)

Create a new Dimension.

Parameters

int

$initialValue

Numeric row index

Reimplemented in PhpOffice\PhpSpreadsheet\Worksheet\ColumnDimension, and PhpOffice\PhpSpreadsheet\Worksheet\RowDimension.

Definition at line 42 of file Dimension.php.

    {
        // set dimension as unformatted by default
        $this->xfIndex = $initialValue;
    }

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::__clone

(

)

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

Definition at line 138 of file Dimension.php.

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

References $key.

getCollapsed()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::getCollapsed

(

)

Get Collapsed.

Definition at line 96 of file Dimension.php.

                                  : bool
    {
        return $this->collapsed;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$collapsed.

getOutlineLevel()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::getOutlineLevel

(

)

Get Outline Level.

Definition at line 71 of file Dimension.php.

                                     : int
    {
        return $this->outlineLevel;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$outlineLevel.

getVisible()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::getVisible

(

)

Get Visible.

Definition at line 51 of file Dimension.php.

                                : bool
    {
        return $this->visible;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$visible.

getXfIndex()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::getXfIndex

(

)

Get index to cellXf.

Returns

int

Definition at line 118 of file Dimension.php.

                                : ?int
    {
        return $this->xfIndex;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$xfIndex.

setCollapsed()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setCollapsed

(

bool

$collapsed

)

Set Collapsed.

Returns

$this

Definition at line 106 of file Dimension.php.

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

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$collapsed.

setOutlineLevel()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setOutlineLevel

(

int

$level

)

Set Outline Level.

Value must be between 0 and 7.

Returns

$this

Definition at line 82 of file Dimension.php.

    {
        if ($level < 0 || $level > 7) {
            throw new PhpSpreadsheetException('Outline level must range between 0 and 7.');
        }
 
        $this->outlineLevel = $level;
 
        return $this;
    }

setVisible()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setVisible

(

bool

$visible

)

Set Visible.

Returns

$this

Definition at line 61 of file Dimension.php.

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

References PhpOffice\PhpSpreadsheet\Worksheet\Dimension\$visible.

setXfIndex()

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::setXfIndex

(

int

$pValue

)

Set index to cellXf.

Returns

$this

Definition at line 128 of file Dimension.php.

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

Field Documentation

$collapsed

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::$collapsed = false

private

Definition at line 28 of file Dimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Dimension\getCollapsed(), and PhpOffice\PhpSpreadsheet\Worksheet\Dimension\setCollapsed().

$outlineLevel

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::$outlineLevel = 0

private

Definition at line 21 of file Dimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Dimension\getOutlineLevel().

$visible

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::$visible = true

private

Definition at line 14 of file Dimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Dimension\getVisible(), and PhpOffice\PhpSpreadsheet\Worksheet\Dimension\setVisible().

$xfIndex

PhpOffice\PhpSpreadsheet\Worksheet\Dimension::$xfIndex

private

Definition at line 35 of file Dimension.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Dimension\getXfIndex().

---

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

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