Properties

$visible

$visible : boolean

Visible?

Type

boolean

$outlineLevel

$outlineLevel : integer

Outline level.

Type

integer

$collapsed

$collapsed : boolean

Collapsed.

Type

boolean

$xfIndex

$xfIndex : null|integer

Index to cellXf. Null value means row has no explicit cellXf format.

Type

null|integer

$columnIndex

$columnIndex : string

Column index.

Type

string

$width

$width : float

Column width.

When this is set to a negative value, the column width should be ignored by IWriter

Type

float

$autoSize

$autoSize : boolean

Auto size?

Type

boolean

Methods

__construct()

__construct(string  $pIndex = 'A') 

Create a new ColumnDimension.

Parameters

string $pIndex

Character column index

getVisible()

getVisible() : boolean

Get Visible.

Returns

boolean

setVisible()

setVisible(boolean  $pValue) : $this

Set Visible.

Parameters

boolean $pValue

Returns

$this

getOutlineLevel()

getOutlineLevel() : integer

Get Outline Level.

Returns

integer

setOutlineLevel()

setOutlineLevel(integer  $pValue) : $this

Set Outline Level.

Value must be between 0 and 7.

Parameters

integer $pValue

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getCollapsed()

getCollapsed() : boolean

Get Collapsed.

Returns

boolean

setCollapsed()

setCollapsed(boolean  $pValue) : $this

Set Collapsed.

Parameters

boolean $pValue

Returns

$this

getXfIndex()

getXfIndex() : integer

Get index to cellXf.

Returns

integer

setXfIndex()

setXfIndex(integer  $pValue) : $this

Set index to cellXf.

Parameters

integer $pValue

Returns

$this

__clone()

__clone() 

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

getColumnIndex()

getColumnIndex() : string

Get column index as string eg: 'A'.

Returns

string

setColumnIndex()

setColumnIndex(string  $pValue) : $this

Set column index as string eg: 'A'.

Parameters

string $pValue

Returns

$this

getWidth()

getWidth() : float

Get Width.

Returns

float

setWidth()

setWidth(float  $pValue) : $this

Set Width.

Parameters

float $pValue

Returns

$this

getAutoSize()

getAutoSize() : boolean

Get Auto Size.

Returns

boolean

setAutoSize()

setAutoSize(boolean  $pValue) : $this

Set Auto Size.

Parameters

boolean $pValue

Returns

$this