PHPExcel_Worksheet
| category | PHPExcel |
|---|---|
| package | PHPExcel_Worksheet |
| copyright | Copyright (c) 2006 - 2013 PHPExcel (http://www.codeplex.com/PHPExcel) |
__clone()
__construct(\PHPExcel $pParent, string $pTitle)
__destruct()
addChart(\PHPExcel_Chart $pChart, int | null $iChartIndex) : \PHPExcel_Chart
\PHPExcel_Chart
intnullIndex where chart should go (0,1,..., or null for last)
calculateColumnWidths(boolean $calculateMergeCells) : \PHPExcel_Worksheet;
booleanCalculate merge cell width
\PHPExcel_Worksheet;calculateWorksheetDataDimension() : string
stringString containing the dimension of this worksheet that actually contain datacalculateWorksheetDimension() : string
stringString containing the dimension of this worksheetcellExists(string $pCoordinate) : boolean
cellExistsByColumnAndRow(string $pColumn, string $pRow) : boolean
stringNumeric column coordinate of the cell
stringNumeric row coordinate of the cell
booleanconditionalStylesExists(string $pCoordinate) : boolean
string
booleandataValidationExists(string $pCoordinate) : boolean
string
booleandisconnectCells()
duplicateConditionalStyle(array $pCellStyle, string $pRange) : \PHPExcel_Worksheet
Please note that this will overwrite existing cell styles for cells in range!
arrayof PHPExcel_Style_Conditional $pCellStyle Cell style to duplicate
stringRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
\PHPExcel_Exception |
|---|
duplicateStyle(\PHPExcel_Style $pCellStyle, string $pRange) : \PHPExcel_Worksheet
Please note that this will overwrite existing cell styles for cells in range!
stringRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
\PHPExcel_Exception |
|---|
duplicateStyleArray(array $pStyles, string $pRange, boolean $pAdvanced) : \PHPExcel_Worksheet
Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. For example, if you decide to set a range of cells to font bold, only include font bold in the styles array.
| deprecated |
|---|
arrayArray containing style information
stringRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
booleanAdvanced mode for setting borders.
\PHPExcel_Exception |
|---|
extractSheetTitle(string $pRange, bool $returnRange) : mixed
Example: extractSheetTitle("testSheet!A1") ==> 'A1' Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1');
stringRange to extract title from
boolReturn range? (see example)
mixedfreezePane(string $pCell) : \PHPExcel_Worksheet
stringCell (i.e. A2) Examples: A2 will freeze the rows above cell A2 (i.e row 1) B1 will freeze the columns to the left of cell B1 (i.e column A) B2 will freeze the rows above and to the left of cell A2 (i.e row 1 and column A)
\PHPExcel_Exception |
|---|
freezePaneByColumnAndRow(int $pColumn, int $pRow) : \PHPExcel_Worksheet
intNumeric column coordinate of the cell
intNumeric row coordinate of the cell
\PHPExcel_Exception |
|---|
fromArray(array $source, mixed $nullValue, string $startCell, boolean $strictNullComparison) : \PHPExcel_Worksheet
arraySource array
mixedValue in source array that stands for blank cell
stringInsert array starting from this cell address as the top left coordinate
booleanApply strict comparison when testing for null values in the array
\PHPExcel_Exception |
|---|
getActiveCell() : string
stringExample: 'A1'getAutoFilter()
@return PHPExcel_Worksheet_AutoFilter
getBreaks() : array[]
array[]getCell(string $pCoordinate) : \PHPExcel_Cell
stringCoordinate of the cell
\PHPExcel_Exception |
|---|
\PHPExcel_CellCell that was foundgetCellByColumnAndRow(string $pColumn, string $pRow) : \PHPExcel_Cell
stringNumeric column coordinate of the cell
stringNumeric row coordinate of the cell
\PHPExcel_CellCell that was foundgetCellCacheController() : \PHPExcel_CachedObjectStorage_xxx
\PHPExcel_CachedObjectStorage_xxxgetChartByIndex(string $index) : false | \PHPExcel_Chart
stringChart index position
\PHPExcel_Exception |
|---|
false\PHPExcel_Chart
getChartCount() : int
intThe number of chartsgetChartNames() : string[]
getColumnDimension(string $pColumn) : \PHPExcel_Worksheet_ColumnDimension
getColumnDimensionByColumn(string $pColumn) : \PHPExcel_Worksheet_ColumnDimension
stringNumeric column coordinate of the cell
getColumnDimensions() : \PHPExcel_Worksheet_ColumnDimension[]
getComment(string $pCellCoordinate) : \PHPExcel_Comment
stringCell coordinate to get comment for
\PHPExcel_Exception |
|---|
getCommentByColumnAndRow(int $pColumn, int $pRow) : \PHPExcel_Comment
intNumeric column coordinate of the cell
intNumeric row coordinate of the cell
getConditionalStyles(string $pCoordinate) : \PHPExcel_Style_Conditional[]
getConditionalStylesCollection() : array
arraygetDataValidation(string $pCellCoordinate)
stringCell coordinate to get data validation for
getDataValidationCollection() : \PHPExcel_Cell_DataValidation[]
getDefaultColumnDimension() : \PHPExcel_Worksheet_ColumnDimension
getDrawingCollection() : \PHPExcel_Worksheet_BaseDrawing[]
getFreezePane() : string
stringgetHashCode() : string
stringHash codegetHighestColumn() : string
stringHighest column namegetHighestDataColumn() : string
stringHighest column name that contains datagetHighestDataRow() : string
stringHighest row number that contains datagetHighestRow() : int
intHighest row numbergetHighestRowAndColumn() : array
arrayHighest column name and highest row numbergetHyperlink(string $pCellCoordinate)
stringCell coordinate to get hyperlink for
getInvalidCharacters() : array
arraygetMergeCells() : array[]
array[]getPrintGridlines() : boolean
booleangetProtectedCells() : array[]
array[]getRightToLeft() : boolean
booleangetRowDimensions() : \PHPExcel_Worksheet_RowDimension[]
getRowIterator(integer $startRow) : \PHPExcel_Worksheet_RowIterator
integerThe row number at which to start iterating
getSelectedCell() : string
| deprecated |
|---|
stringgetSelectedCells() : string
stringgetSheetState() : string
stringSheet state (visible, hidden, veryHidden)getShowGridlines() : boolean
booleangetShowRowColHeaders() : boolean
booleangetShowSummaryBelow() : boolean
booleangetShowSummaryRight() : boolean
booleangetStyle(string $pCellCoordinate) : \PHPExcel_Style
stringCell coordinate to get style for
\PHPExcel_Exception |
|---|
getStyleByColumnAndRow(int $pColumn, int $pRow) : \PHPExcel_Style
intNumeric column coordinate of the cell
intNumeric row coordinate of the cell
getTitle() : string
stringhyperlinkExists(string $pCoordinate) : boolean
string
booleaninsertNewColumnBefore(int $pBefore, int $pNumCols) : \PHPExcel_Worksheet
intInsert before this one
intNumber of columns to insert
\PHPExcel_Exception |
|---|
insertNewColumnBeforeByIndex(int $pBefore, int $pNumCols) : \PHPExcel_Worksheet
intInsert before this one (numeric column coordinate of the cell)
intNumber of columns to insert
\PHPExcel_Exception |
|---|
insertNewRowBefore(int $pBefore, int $pNumRows) : \PHPExcel_Worksheet
intInsert before this one
intNumber of rows to insert
\PHPExcel_Exception |
|---|
isTabColorSet() : boolean
booleanmergeCells(string $pRange) : \PHPExcel_Worksheet
mergeCellsByColumnAndRow(int $pColumn1, int $pRow1, int $pColumn2, int $pRow2) : \PHPExcel_Worksheet
intNumeric column coordinate of the first cell
intNumeric row coordinate of the first cell
intNumeric column coordinate of the last cell
intNumeric row coordinate of the last cell
\PHPExcel_Exception |
|---|
namedRangeToArray(string $pNamedRange, mixed $nullValue, boolean $calculateFormulas, boolean $formatData, boolean $returnCellRef) : array
stringName of the Named Range
mixedValue returned in the array entry if a cell doesn't exist
booleanShould formulas be calculated?
booleanShould formatting be applied to cell values?
booleanFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
\PHPExcel_Exception |
|---|
arrayprotectCells(string $pRange, string $pPassword, boolean $pAlreadyHashed) : \PHPExcel_Worksheet
stringCell (e.g. A1) or cell range (e.g. A1:E1)
stringPassword to unlock the protection
booleanIf the password has already been hashed, set this to true
\PHPExcel_Exception |
|---|
protectCellsByColumnAndRow(int $pColumn1, int $pRow1, int $pColumn2, int $pRow2, string $pPassword, boolean $pAlreadyHashed) : \PHPExcel_Worksheet
intNumeric column coordinate of the first cell
intNumeric row coordinate of the first cell
intNumeric column coordinate of the last cell
intNumeric row coordinate of the last cell
stringPassword to unlock the protection
booleanIf the password has already been hashed, set this to true
\PHPExcel_Exception |
|---|
rangeToArray(string $pRange, mixed $nullValue, boolean $calculateFormulas, boolean $formatData, boolean $returnCellRef) : array
stringRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
mixedValue returned in the array entry if a cell doesn't exist
booleanShould formulas be calculated?
booleanShould formatting be applied to cell values?
booleanFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
arrayremoveColumn(int $pColumn, int $pNumCols) : \PHPExcel_Worksheet
intRemove starting with this one
intNumber of columns to remove
\PHPExcel_Exception |
|---|
removeColumnByIndex(int $pColumn, int $pNumCols) : \PHPExcel_Worksheet
intRemove starting with this one (numeric column coordinate of the cell)
intNumber of columns to remove
\PHPExcel_Exception |
|---|
removeConditionalStyles(string $pCoordinate) : \PHPExcel_Worksheet
removeRow(int $pRow, int $pNumRows) : \PHPExcel_Worksheet
intRemove starting with this one
intNumber of rows to remove
\PHPExcel_Exception |
|---|
setAutoFilter($pValue)
@param PHPExcel_Worksheet_AutoFilter|string $pValue A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
\PHPExcel_Exception |
@return PHPExcel_Worksheet |
|---|
setAutoFilterByColumnAndRow($pColumn1, integer $pRow1, $pColumn2, $pRow2)
@param integer $pColumn1 Numeric column coordinate of the first cell
integerNumeric row coordinate of the first cell @param integer $pColumn2 Numeric column coordinate of the second cell @param integer $pRow2 Numeric row coordinate of the second cell @throws PHPExcel_Exception @return PHPExcel_Worksheet
setBreak(string $pCell, int $pBreak) : \PHPExcel_Worksheet
stringCell coordinate (e.g. A1)
intBreak type (type of PHPExcel_Worksheet::BREAK_*)
\PHPExcel_Exception |
|---|
setBreakByColumnAndRow(integer $pColumn, integer $pRow, integer $pBreak) : \PHPExcel_Worksheet
integerNumeric column coordinate of the cell
integerNumeric row coordinate of the cell
integerBreak type (type of PHPExcel_Worksheet::BREAK_*)
setCellValue(string $pCoordinate, mixed $pValue, bool $returnCell) : \PHPExcel_Worksheet | \PHPExcel_Cell
stringCoordinate of the cell
mixedValue of the cell
boolReturn the worksheet (false, default) or the cell (true)
\PHPExcel_Worksheet\PHPExcel_CellDepending on the last parameter being specifiedsetCellValueByColumnAndRow(string $pColumn, string $pRow, mixed $pValue, bool $returnCell) : \PHPExcel_Worksheet | \PHPExcel_Cell
stringNumeric column coordinate of the cell (A = 0)
stringNumeric row coordinate of the cell
mixedValue of the cell
boolReturn the worksheet (false, default) or the cell (true)
\PHPExcel_Worksheet\PHPExcel_CellDepending on the last parameter being specifiedsetCellValueExplicit(string $pCoordinate, mixed $pValue, string $pDataType, bool $returnCell) : \PHPExcel_Worksheet | \PHPExcel_Cell
stringCoordinate of the cell
mixedValue of the cell
stringExplicit data type
boolReturn the worksheet (false, default) or the cell (true)
\PHPExcel_Worksheet\PHPExcel_CellDepending on the last parameter being specifiedsetCellValueExplicitByColumnAndRow(string $pColumn, string $pRow, mixed $pValue, string $pDataType, bool $returnCell) : \PHPExcel_Worksheet | \PHPExcel_Cell
stringNumeric column coordinate of the cell
stringNumeric row coordinate of the cell
mixedValue of the cell
stringExplicit data type
boolReturn the worksheet (false, default) or the cell (true)
\PHPExcel_Worksheet\PHPExcel_CellDepending on the last parameter being specifiedsetConditionalStyles($pCoordinate, $pValue) : \PHPExcel_Worksheet
string E.g. 'A1'
PHPExcel_Style_Conditional[]
setDataValidation(string $pCellCoordinate, \PHPExcel_Cell_DataValidation $pDataValidation) : \PHPExcel_Worksheet
stringCell coordinate to insert data validation
\PHPExcel_Cell_DataValidation
setDefaultStyle(\PHPExcel_Style $pValue) : \PHPExcel_Worksheet
setHyperlink(string $pCellCoordinate, \PHPExcel_Cell_Hyperlink $pHyperlink) : \PHPExcel_Worksheet
stringCell coordinate to insert hyperlink
\PHPExcel_Cell_Hyperlink
setMergeCells(array $pValue)
Use instead mergeCells() to merge a single cell range.
array
setSelectedCellByColumnAndRow(int $pColumn, int $pRow) : \PHPExcel_Worksheet
intNumeric column coordinate of the cell
intNumeric row coordinate of the cell
\PHPExcel_Exception |
|---|
setSelectedCells(string $pCoordinate) : \PHPExcel_Worksheet
stringCell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'
\PHPExcel_Exception |
|---|
setSharedStyle(\PHPExcel_Style $pSharedCellStyle, string $pRange) : \PHPExcel_Worksheet
Please note that this will overwrite existing cell styles for cells in range!
| deprecated |
|---|
stringRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
\PHPExcel_Exception |
|---|
setTitle(string $pValue, string $updateFormulaCellReferences) : \PHPExcel_Worksheet
stringString containing the dimension of this worksheet
stringboolean Flag indicating whether cell references in formulae should be updated to reflect the new sheet name. This should be left as the default true, unless you are certain that no formula cells on any worksheet contain references to this worksheet
shrinkRangeToFit(string $range) : string
string
stringAdjusted range valuetoArray(mixed $nullValue, boolean $calculateFormulas, boolean $formatData, boolean $returnCellRef) : array
mixedValue returned in the array entry if a cell doesn't exist
booleanShould formulas be calculated?
booleanShould formatting be applied to cell values?
booleanFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
arrayunmergeCells(string $pRange) : \PHPExcel_Worksheet
unmergeCellsByColumnAndRow(int $pColumn1, int $pRow1, int $pColumn2, int $pRow2) : \PHPExcel_Worksheet
intNumeric column coordinate of the first cell
intNumeric row coordinate of the first cell
intNumeric column coordinate of the last cell
intNumeric row coordinate of the last cell
\PHPExcel_Exception |
|---|
unprotectCells(string $pRange) : \PHPExcel_Worksheet
stringCell (e.g. A1) or cell range (e.g. A1:E1)
\PHPExcel_Exception |
|---|
unprotectCellsByColumnAndRow(int $pColumn1, int $pRow1, int $pColumn2, int $pRow2, string $pPassword, boolean $pAlreadyHashed) : \PHPExcel_Worksheet
intNumeric column coordinate of the first cell
intNumeric row coordinate of the first cell
intNumeric column coordinate of the last cell
intNumeric row coordinate of the last cell
stringPassword to unlock the protection
booleanIf the password has already been hashed, set this to true
\PHPExcel_Exception |
|---|
_checkSheetTitle(string $pValue) : string
stringThe string to check
\PHPExcel_Exception |
|---|
stringThe valid string$_activeCell : string
(Only one!)
$_autoFilter : \PHPExcel_Worksheet_AutoFilter
$_breaks : array
$_cachedHighestColumn : string
$_cachedHighestRow : int
$_cellCollection : \PHPExcel_CachedObjectStorage_xxx
$_cellCollectionIsSorted : boolean
$_chartCollection : \PHPExcel_Chart[]
$_columnDimensions : \PHPExcel_Worksheet_ColumnDimension[]
$_conditionalStylesCollection : array
Indexed by cell coordinate, e.g. 'A1'
$_dataValidationCollection : array
Indexed by cell coordinate, e.g. 'A1'
$_defaultColumnDimension : \PHPExcel_Worksheet_ColumnDimension
$_defaultRowDimension : \PHPExcel_Worksheet_RowDimension
$_dirty : boolean
$_drawingCollection : \PHPExcel_Worksheet_BaseDrawing[]
$_freezePane : string
$_hash : string
$_hyperlinkCollection : array
Indexed by cell coordinate, e.g. 'A1'
$_invalidCharacters : array
$_mergeCells : array
$_pageMargins : \PHPExcel_Worksheet_PageMargins
$_pageSetup : \PHPExcel_Worksheet_PageSetup
$_parent : \PHPExcel
$_printGridlines : boolean
$_protectedCells : array
$_protection : \PHPExcel_Worksheet_Protection
$_rightToLeft : boolean
$_rowDimensions : \PHPExcel_Worksheet_RowDimension[]
$_selectedCells : string
$_sheetState : string
$_sheetView : \PHPExcel_Worksheet_SheetView
$_showGridlines : boolean
$_showRowColHeaders : boolean
$_showSummaryBelow : boolean
$_showSummaryRight : boolean
$_styles : \PHPExcel_Style[]
$_tabColor : \PHPExcel_Style_Color
$_title : string
BREAK_COLUMN
BREAK_NONE
BREAK_ROW
SHEETSTATE_HIDDEN
SHEETSTATE_VERYHIDDEN
SHEETSTATE_VISIBLE