\PhpOffice\PhpSpreadsheet\WorksheetColumnDimension

Summary

Methods
Properties
Constants
__construct()
getVisible()
setVisible()
getOutlineLevel()
setOutlineLevel()
getCollapsed()
setCollapsed()
getXfIndex()
setXfIndex()
__clone()
getColumnIndex()
setColumnIndex()
getWidth()
setWidth()
getAutoSize()
setAutoSize()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$visible
$outlineLevel
$collapsed
$xfIndex
$columnIndex
$width
$autoSize
N/A

Properties

$visible

$visible : bool

Visible?

Type

bool

$outlineLevel

$outlineLevel : int

Outline level.

Type

int

$collapsed

$collapsed : bool

Collapsed.

Type

bool

$xfIndex

$xfIndex : null|int

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

Type

null|int

$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 : bool

Auto size?

Type

bool

Methods

__construct()

__construct(string  $pIndex = 'A') : mixed

Create a new ColumnDimension.

Parameters

string $pIndex

Character column index

Returns

mixed —

getVisible()

getVisible() : bool

Get Visible.

Returns

bool —

setVisible()

setVisible(bool  $visible) : $this

Set Visible.

Parameters

bool $visible

Returns

$this —

getOutlineLevel()

getOutlineLevel() : int

Get Outline Level.

Returns

int —

setOutlineLevel()

setOutlineLevel(int  $level) : $this

Set Outline Level.

Value must be between 0 and 7.

Parameters

int $level

Returns

$this —

getCollapsed()

getCollapsed() : bool

Get Collapsed.

Returns

bool —

setCollapsed()

setCollapsed(bool  $collapsed) : $this

Set Collapsed.

Parameters

bool $collapsed

Returns

$this —

getXfIndex()

getXfIndex() : int

Get index to cellXf.

Returns

int —

setXfIndex()

setXfIndex(int  $pValue) : $this

Set index to cellXf.

Parameters

int $pValue

Returns

$this —

__clone()

__clone() : mixed

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

Returns

mixed —

getColumnIndex()

getColumnIndex() : string

Get column index as string eg: 'A'.

Returns

string —

setColumnIndex()

setColumnIndex(string  $index) : $this

Set column index as string eg: 'A'.

Parameters

string $index

Returns

$this —

getWidth()

getWidth() : float

Get Width.

Returns

float —

setWidth()

setWidth(float  $width) : $this

Set Width.

Parameters

float $width

Returns

$this —

getAutoSize()

getAutoSize() : bool

Get Auto Size.

Returns

bool —

setAutoSize()

setAutoSize(bool  $autosizeEnabled) : $this

Set Auto Size.

Parameters

bool $autosizeEnabled

Returns

$this —