\PHPExcel_Worksheet_ColumnDimension

PHPExcel_Worksheet_ColumnDimension

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

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 : boolean

Visible?

Type

boolean

$outlineLevel

$outlineLevel : integer

Outline level

Type

integer

$collapsed

$collapsed : boolean

Collapsed

Type

boolean

$xfIndex

$xfIndex : integer|null

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

Type

integer|null

$columnIndex

$columnIndex : integer

Column index

Type

integer

$width

$width : double

Column width

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

Type

double

$autoSize

$autoSize : boolean

Auto size?

Type

boolean

Methods

__construct()

__construct(string  $pIndex = 'A') 

Create a new PHPExcel_Worksheet_ColumnDimension

Parameters

string $pIndex

Character column index

getVisible()

getVisible() : boolean

Get Visible

Returns

boolean

setVisible()

setVisible(boolean  $pValue = true) : \PHPExcel_Worksheet_Dimension

Set Visible

Parameters

boolean $pValue

Returns

\PHPExcel_Worksheet_Dimension

getOutlineLevel()

getOutlineLevel() : integer

Get Outline Level

Returns

integer

setOutlineLevel()

setOutlineLevel(integer  $pValue) : \PHPExcel_Worksheet_Dimension

Set Outline Level

Value must be between 0 and 7

Parameters

integer $pValue

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_Dimension

getCollapsed()

getCollapsed() : boolean

Get Collapsed

Returns

boolean

setCollapsed()

setCollapsed(boolean  $pValue = true) : \PHPExcel_Worksheet_Dimension

Set Collapsed

Parameters

boolean $pValue

Returns

\PHPExcel_Worksheet_Dimension

getXfIndex()

getXfIndex() : integer

Get index to cellXf

Returns

integer

setXfIndex()

setXfIndex(integer  $pValue) : \PHPExcel_Worksheet_Dimension

Set index to cellXf

Parameters

integer $pValue

Returns

\PHPExcel_Worksheet_Dimension

__clone()

__clone() 

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

getColumnIndex()

getColumnIndex() : string

Get ColumnIndex

Returns

string

getWidth()

getWidth() : double

Get Width

Returns

double

getAutoSize()

getAutoSize() : boolean

Get Auto Size

Returns

boolean

setAutoSize()

setAutoSize(boolean  $pValue = false) : \PHPExcel_Worksheet_ColumnDimension

Set Auto Size

Parameters

boolean $pValue

Returns

\PHPExcel_Worksheet_ColumnDimension