BREAK_NONE
BREAK_NONE = 0
PHPExcel_Worksheet
$_parent : \PHPExcel
Parent spreadsheet
$_rowDimensions : array<mixed,\PHPExcel_Worksheet_RowDimension>
Collection of row dimensions
$_defaultRowDimension : \PHPExcel_Worksheet_RowDimension
Default row dimension
$_columnDimensions : array<mixed,\PHPExcel_Worksheet_ColumnDimension>
Collection of column dimensions
$_defaultColumnDimension : \PHPExcel_Worksheet_ColumnDimension
Default column dimension
$_drawingCollection : array<mixed,\PHPExcel_Worksheet_BaseDrawing>
Collection of drawings
$_chartCollection : array<mixed,\PHPExcel_Chart>
Collection of Chart objects
$_pageSetup : \PHPExcel_Worksheet_PageSetup
Page setup
$_pageMargins : \PHPExcel_Worksheet_PageMargins
Page margins
$_headerFooter : \PHPExcel_Worksheet_HeaderFooter
Page header/footer
$_sheetView : \PHPExcel_Worksheet_SheetView
Sheet view
$_protection : \PHPExcel_Worksheet_Protection
Protection
$_styles : array<mixed,\PHPExcel_Style>
Collection of styles
$_autoFilter : \PHPExcel_Worksheet_AutoFilter
Autofilter Range and selection
$_comments : array<mixed,\PHPExcel_Comment>
Collection of comments
$_tabColor : \PHPExcel_Style_Color
Tab color
__construct(\PHPExcel $pParent = null, string $pTitle = 'Worksheet')
Create a new worksheet
| \PHPExcel | $pParent | |
| string | $pTitle |
getCellCollection(boolean $pSorted = true) : array<mixed,\PHPExcel_Cell>
Get collection of cells
| boolean | $pSorted | Also sort the cell collection? |
sortCellCollection() : \PHPExcel_Worksheet
Sort collection of cells
getRowDimensions() : array<mixed,\PHPExcel_Worksheet_RowDimension>
Get collection of row dimensions
getDefaultRowDimension() : \PHPExcel_Worksheet_RowDimension
Get default row dimension
getColumnDimensions() : array<mixed,\PHPExcel_Worksheet_ColumnDimension>
Get collection of column dimensions
getDefaultColumnDimension() : \PHPExcel_Worksheet_ColumnDimension
Get default column dimension
getDrawingCollection() : array<mixed,\PHPExcel_Worksheet_BaseDrawing>
Get collection of drawings
getChartCollection() : array<mixed,\PHPExcel_Chart>
Get collection of charts
addChart(\PHPExcel_Chart $pChart = null, integer|null $iChartIndex = null) : \PHPExcel_Chart
Add chart
| \PHPExcel_Chart | $pChart | |
| integer|null | $iChartIndex | Index where chart should go (0,1,..., or null for last) |
getChartByIndex(string $index = null) : false|\PHPExcel_Chart
Get a chart by its index position
| string | $index | Chart index position |
getChartByName(string $chartName = '') : false|\PHPExcel_Chart
Get a chart by name
| string | $chartName | Chart name |
refreshColumnDimensions() : \PHPExcel_Worksheet
Refresh column dimensions
refreshRowDimensions() : \PHPExcel_Worksheet
Refresh row dimensions
getParent() : \PHPExcel
Get parent
rebindParent(\PHPExcel $parent) : \PHPExcel_Worksheet
Re-bind parent
| \PHPExcel | $parent |
setTitle(string $pValue = 'Worksheet', string $updateFormulaCellReferences = true) : \PHPExcel_Worksheet
Set title
| string | $pValue | String containing the dimension of this worksheet |
| string | $updateFormulaCellReferences | boolean 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 |
setSheetState(string $value = \PHPExcel_Worksheet::SHEETSTATE_VISIBLE) : \PHPExcel_Worksheet
Set sheet state
| string | $value | Sheet state (visible, hidden, veryHidden) |
getPageSetup() : \PHPExcel_Worksheet_PageSetup
Get page setup
setPageSetup(\PHPExcel_Worksheet_PageSetup $pValue) : \PHPExcel_Worksheet
Set page setup
| \PHPExcel_Worksheet_PageSetup | $pValue |
getPageMargins() : \PHPExcel_Worksheet_PageMargins
Get page margins
setPageMargins(\PHPExcel_Worksheet_PageMargins $pValue) : \PHPExcel_Worksheet
Set page margins
| \PHPExcel_Worksheet_PageMargins | $pValue |
getHeaderFooter() : \PHPExcel_Worksheet_HeaderFooter
Get page header/footer
setHeaderFooter(\PHPExcel_Worksheet_HeaderFooter $pValue) : \PHPExcel_Worksheet
Set page header/footer
| \PHPExcel_Worksheet_HeaderFooter | $pValue |
getSheetView() : \PHPExcel_Worksheet_SheetView
Get sheet view
setSheetView(\PHPExcel_Worksheet_SheetView $pValue) : \PHPExcel_Worksheet
Set sheet view
| \PHPExcel_Worksheet_SheetView | $pValue |
getProtection() : \PHPExcel_Worksheet_Protection
Get Protection
setProtection(\PHPExcel_Worksheet_Protection $pValue) : \PHPExcel_Worksheet
Set Protection
| \PHPExcel_Worksheet_Protection | $pValue |
setCellValue(string $pCoordinate = 'A1', mixed $pValue = null, boolean $returnCell = false) : \PHPExcel_Worksheet|\PHPExcel_Cell
Set a cell value
| string | $pCoordinate | Coordinate of the cell |
| mixed | $pValue | Value of the cell |
| boolean | $returnCell | Return the worksheet (false, default) or the cell (true) |
Depending on the last parameter being specified
setCellValueByColumnAndRow(string $pColumn, string $pRow = 1, mixed $pValue = null, boolean $returnCell = false) : \PHPExcel_Worksheet|\PHPExcel_Cell
Set a cell value by using numeric cell coordinates
| string | $pColumn | Numeric column coordinate of the cell (A = 0) |
| string | $pRow | Numeric row coordinate of the cell |
| mixed | $pValue | Value of the cell |
| boolean | $returnCell | Return the worksheet (false, default) or the cell (true) |
Depending on the last parameter being specified
setCellValueExplicit(string $pCoordinate = 'A1', mixed $pValue = null, string $pDataType = \PHPExcel_Cell_DataType::TYPE_STRING, boolean $returnCell = false) : \PHPExcel_Worksheet|\PHPExcel_Cell
Set a cell value
| string | $pCoordinate | Coordinate of the cell |
| mixed | $pValue | Value of the cell |
| string | $pDataType | Explicit data type |
| boolean | $returnCell | Return the worksheet (false, default) or the cell (true) |
Depending on the last parameter being specified
setCellValueExplicitByColumnAndRow(string $pColumn, string $pRow = 1, mixed $pValue = null, string $pDataType = \PHPExcel_Cell_DataType::TYPE_STRING, boolean $returnCell = false) : \PHPExcel_Worksheet|\PHPExcel_Cell
Set a cell value by using numeric cell coordinates
| string | $pColumn | Numeric column coordinate of the cell |
| string | $pRow | Numeric row coordinate of the cell |
| mixed | $pValue | Value of the cell |
| string | $pDataType | Explicit data type |
| boolean | $returnCell | Return the worksheet (false, default) or the cell (true) |
Depending on the last parameter being specified
getCell(string $pCoordinate = 'A1') : \PHPExcel_Cell
Get cell at a specific coordinate
| string | $pCoordinate | Coordinate of the cell |
Cell that was found
getCellByColumnAndRow(string $pColumn, string $pRow = 1) : \PHPExcel_Cell
Get cell at a specific coordinate by using numeric cell coordinates
| string | $pColumn | Numeric column coordinate of the cell |
| string | $pRow | Numeric row coordinate of the cell |
Cell that was found
getRowDimension(integer $pRow = 1) : \PHPExcel_Worksheet_RowDimension
Get row dimension at a specific row
| integer | $pRow | Numeric index of the row |
getColumnDimension(string $pColumn = 'A') : \PHPExcel_Worksheet_ColumnDimension
Get column dimension at a specific column
| string | $pColumn | String index of the column |
getColumnDimensionByColumn(string $pColumn) : \PHPExcel_Worksheet_ColumnDimension
Get column dimension at a specific column by using numeric cell coordinates
| string | $pColumn | Numeric column coordinate of the cell |
getStyles() : array<mixed,\PHPExcel_Style>
Get styles
getDefaultStyle() : \PHPExcel_Style
Get default style of workbook.
setDefaultStyle(\PHPExcel_Style $pValue) : \PHPExcel_Worksheet
Set default style - should only be used by PHPExcel_IReader implementations!
| \PHPExcel_Style | $pValue |
getStyle(string $pCellCoordinate = 'A1') : \PHPExcel_Style
Get style for cell
| string | $pCellCoordinate | Cell coordinate to get style for |
getConditionalStyles(string $pCoordinate = 'A1') : array<mixed,\PHPExcel_Style_Conditional>
Get conditional styles for a cell
| string | $pCoordinate |
removeConditionalStyles(string $pCoordinate = 'A1') : \PHPExcel_Worksheet
Removes conditional styles for a cell
| string | $pCoordinate |
setConditionalStyles( $pCoordinate = 'A1', $pValue) : \PHPExcel_Worksheet
Set conditional styles
| $pCoordinate | string E.g. 'A1' |
|
| $pValue | PHPExcel_Style_Conditional[] |
getStyleByColumnAndRow(integer $pColumn, integer $pRow = 1) : \PHPExcel_Style
Get style for cell by using numeric cell coordinates
| integer | $pColumn | Numeric column coordinate of the cell |
| integer | $pRow | Numeric row coordinate of the cell |
setSharedStyle(\PHPExcel_Style $pSharedCellStyle = null, string $pRange = '') : \PHPExcel_Worksheet
Set shared cell style to a range of cells
Please note that this will overwrite existing cell styles for cells in range!
| \PHPExcel_Style | $pSharedCellStyle | Cell style to share |
| string | $pRange | Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") |
duplicateStyle(\PHPExcel_Style $pCellStyle = null, string $pRange = '') : \PHPExcel_Worksheet
Duplicate cell style to a range of cells
Please note that this will overwrite existing cell styles for cells in range!
| \PHPExcel_Style | $pCellStyle | Cell style to duplicate |
| string | $pRange | Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") |
duplicateConditionalStyle(array $pCellStyle = null, string $pRange = '') : \PHPExcel_Worksheet
Duplicate conditional style to a range of cells
Please note that this will overwrite existing cell styles for cells in range!
| array | $pCellStyle | |
| string | $pRange | Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") |
duplicateStyleArray(array $pStyles = null, string $pRange = '', boolean $pAdvanced = true) : \PHPExcel_Worksheet
Duplicate cell style array to a range of cells
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.
| array | $pStyles | Array containing style information |
| string | $pRange | Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") |
| boolean | $pAdvanced | Advanced mode for setting borders. |
setBreak(string $pCell = 'A1', integer $pBreak = \PHPExcel_Worksheet::BREAK_NONE) : \PHPExcel_Worksheet
Set break on a cell
| string | $pCell | Cell coordinate (e.g. A1) |
| integer | $pBreak | Break type (type of PHPExcelWorksheet::BREAK*) |
setBreakByColumnAndRow(integer $pColumn, integer $pRow = 1, integer $pBreak = \PHPExcel_Worksheet::BREAK_NONE) : \PHPExcel_Worksheet
Set break on a cell by using numeric cell coordinates
| integer | $pColumn | Numeric column coordinate of the cell |
| integer | $pRow | Numeric row coordinate of the cell |
| integer | $pBreak | Break type (type of PHPExcelWorksheet::BREAK*) |
mergeCells(string $pRange = 'A1:A1') : \PHPExcel_Worksheet
Set merge on a cell range
| string | $pRange | Cell range (e.g. A1:E1) |
mergeCellsByColumnAndRow(integer $pColumn1, integer $pRow1 = 1, integer $pColumn2, integer $pRow2 = 1) : \PHPExcel_Worksheet
Set merge on a cell range by using numeric cell coordinates
| integer | $pColumn1 | Numeric column coordinate of the first cell |
| integer | $pRow1 | Numeric row coordinate of the first cell |
| integer | $pColumn2 | Numeric column coordinate of the last cell |
| integer | $pRow2 | Numeric row coordinate of the last cell |
unmergeCells(string $pRange = 'A1:A1') : \PHPExcel_Worksheet
Remove merge on a cell range
| string | $pRange | Cell range (e.g. A1:E1) |
unmergeCellsByColumnAndRow(integer $pColumn1, integer $pRow1 = 1, integer $pColumn2, integer $pRow2 = 1) : \PHPExcel_Worksheet
Remove merge on a cell range by using numeric cell coordinates
| integer | $pColumn1 | Numeric column coordinate of the first cell |
| integer | $pRow1 | Numeric row coordinate of the first cell |
| integer | $pColumn2 | Numeric column coordinate of the last cell |
| integer | $pRow2 | Numeric row coordinate of the last cell |
protectCells(string $pRange = 'A1', string $pPassword = '', boolean $pAlreadyHashed = false) : \PHPExcel_Worksheet
Set protection on a cell range
| string | $pRange | Cell (e.g. A1) or cell range (e.g. A1:E1) |
| string | $pPassword | Password to unlock the protection |
| boolean | $pAlreadyHashed | If the password has already been hashed, set this to true |
protectCellsByColumnAndRow(integer $pColumn1, integer $pRow1 = 1, integer $pColumn2, integer $pRow2 = 1, string $pPassword = '', boolean $pAlreadyHashed = false) : \PHPExcel_Worksheet
Set protection on a cell range by using numeric cell coordinates
| integer | $pColumn1 | Numeric column coordinate of the first cell |
| integer | $pRow1 | Numeric row coordinate of the first cell |
| integer | $pColumn2 | Numeric column coordinate of the last cell |
| integer | $pRow2 | Numeric row coordinate of the last cell |
| string | $pPassword | Password to unlock the protection |
| boolean | $pAlreadyHashed | If the password has already been hashed, set this to true |
unprotectCells(string $pRange = 'A1') : \PHPExcel_Worksheet
Remove protection on a cell range
| string | $pRange | Cell (e.g. A1) or cell range (e.g. A1:E1) |
unprotectCellsByColumnAndRow(integer $pColumn1, integer $pRow1 = 1, integer $pColumn2, integer $pRow2 = 1, string $pPassword = '', boolean $pAlreadyHashed = false) : \PHPExcel_Worksheet
Remove protection on a cell range by using numeric cell coordinates
| integer | $pColumn1 | Numeric column coordinate of the first cell |
| integer | $pRow1 | Numeric row coordinate of the first cell |
| integer | $pColumn2 | Numeric column coordinate of the last cell |
| integer | $pRow2 | Numeric row coordinate of the last cell |
| string | $pPassword | Password to unlock the protection |
| boolean | $pAlreadyHashed | If the password has already been hashed, set this to true |
setAutoFilterByColumnAndRow( $pColumn1, integer $pRow1 = 1, $pColumn2, $pRow2 = 1)
Set Autofilter Range by using numeric cell coordinates
@param integer $pColumn1 Numeric column coordinate of the first cell
| $pColumn1 | ||
| integer | $pRow1 | Numeric 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 |
| $pColumn2 | ||
| $pRow2 |
removeAutoFilter() : \PHPExcel_Worksheet
Remove autofilter
freezePane(string $pCell = '') : \PHPExcel_Worksheet
Freeze Pane
| string | $pCell | Cell (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) |
freezePaneByColumnAndRow(integer $pColumn, integer $pRow = 1) : \PHPExcel_Worksheet
Freeze Pane by using numeric cell coordinates
| integer | $pColumn | Numeric column coordinate of the cell |
| integer | $pRow | Numeric row coordinate of the cell |
unfreezePane() : \PHPExcel_Worksheet
Unfreeze Pane
insertNewRowBefore(integer $pBefore = 1, integer $pNumRows = 1) : \PHPExcel_Worksheet
Insert a new row, updating all possible related data
| integer | $pBefore | Insert before this one |
| integer | $pNumRows | Number of rows to insert |
insertNewColumnBefore(integer $pBefore = 'A', integer $pNumCols = 1) : \PHPExcel_Worksheet
Insert a new column, updating all possible related data
| integer | $pBefore | Insert before this one |
| integer | $pNumCols | Number of columns to insert |
insertNewColumnBeforeByIndex(integer $pBefore, integer $pNumCols = 1) : \PHPExcel_Worksheet
Insert a new column, updating all possible related data
| integer | $pBefore | Insert before this one (numeric column coordinate of the cell) |
| integer | $pNumCols | Number of columns to insert |
removeRow(integer $pRow = 1, integer $pNumRows = 1) : \PHPExcel_Worksheet
Delete a row, updating all possible related data
| integer | $pRow | Remove starting with this one |
| integer | $pNumRows | Number of rows to remove |
removeColumn(integer $pColumn = 'A', integer $pNumCols = 1) : \PHPExcel_Worksheet
Remove a column, updating all possible related data
| integer | $pColumn | Remove starting with this one |
| integer | $pNumCols | Number of columns to remove |
removeColumnByIndex(integer $pColumn, integer $pNumCols = 1) : \PHPExcel_Worksheet
Remove a column, updating all possible related data
| integer | $pColumn | Remove starting with this one (numeric column coordinate of the cell) |
| integer | $pNumCols | Number of columns to remove |
setShowGridlines(boolean $pValue = false) : \PHPExcel_Worksheet
Set show gridlines
| boolean | $pValue | Show gridlines (true/false) |
setPrintGridlines(boolean $pValue = false) : \PHPExcel_Worksheet
Set print gridlines
| boolean | $pValue | Print gridlines (true/false) |
setShowRowColHeaders(boolean $pValue = false) : \PHPExcel_Worksheet
Set show row and column headers
| boolean | $pValue | Show row and column headers (true/false) |
setShowSummaryBelow(boolean $pValue = true) : \PHPExcel_Worksheet
Set show summary below
| boolean | $pValue | Show summary below (true/false) |
setShowSummaryRight(boolean $pValue = true) : \PHPExcel_Worksheet
Set show summary right
| boolean | $pValue | Show summary right (true/false) |
getComments() : array<mixed,\PHPExcel_Comment>
Get comments
setComments( $pValue = array()) : \PHPExcel_Worksheet
Set comments array for the entire sheet.
| $pValue |
getComment(string $pCellCoordinate = 'A1') : \PHPExcel_Comment
Get comment for cell
| string | $pCellCoordinate | Cell coordinate to get comment for |
getCommentByColumnAndRow(integer $pColumn, integer $pRow = 1) : \PHPExcel_Comment
Get comment for cell by using numeric cell coordinates
| integer | $pColumn | Numeric column coordinate of the cell |
| integer | $pRow | Numeric row coordinate of the cell |
setSelectedCell(string $pCoordinate = 'A1') : \PHPExcel_Worksheet
Selected cell
| string | $pCoordinate | Cell (i.e. A1) |
setSelectedCells(string $pCoordinate = 'A1') : \PHPExcel_Worksheet
Select a range of cells.
| string | $pCoordinate | Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6' |
setSelectedCellByColumnAndRow(integer $pColumn, integer $pRow = 1) : \PHPExcel_Worksheet
Selected cell by using numeric cell coordinates
| integer | $pColumn | Numeric column coordinate of the cell |
| integer | $pRow | Numeric row coordinate of the cell |
setRightToLeft(boolean $value = false) : \PHPExcel_Worksheet
Set right-to-left
| boolean | $value | Right-to-left true/false |
fromArray(array $source = null, mixed $nullValue = null, string $startCell = 'A1', boolean $strictNullComparison = false) : \PHPExcel_Worksheet
Fill worksheet from values in array
| array | $source | Source array |
| mixed | $nullValue | Value in source array that stands for blank cell |
| string | $startCell | Insert array starting from this cell address as the top left coordinate |
| boolean | $strictNullComparison | Apply strict comparison when testing for null values in the array |
rangeToArray(string $pRange = 'A1', mixed $nullValue = null, boolean $calculateFormulas = true, boolean $formatData = true, boolean $returnCellRef = false) : array
Create array from a range of cells
| string | $pRange | Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") |
| mixed | $nullValue | Value returned in the array entry if a cell doesn't exist |
| boolean | $calculateFormulas | Should formulas be calculated? |
| boolean | $formatData | Should formatting be applied to cell values? |
| boolean | $returnCellRef | False - 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 |
namedRangeToArray(string $pNamedRange = '', mixed $nullValue = null, boolean $calculateFormulas = true, boolean $formatData = true, boolean $returnCellRef = false) : array
Create array from a range of cells
| string | $pNamedRange | Name of the Named Range |
| mixed | $nullValue | Value returned in the array entry if a cell doesn't exist |
| boolean | $calculateFormulas | Should formulas be calculated? |
| boolean | $formatData | Should formatting be applied to cell values? |
| boolean | $returnCellRef | False - 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 |
toArray(mixed $nullValue = null, boolean $calculateFormulas = true, boolean $formatData = true, boolean $returnCellRef = false) : array
Create array from worksheet
| mixed | $nullValue | Value returned in the array entry if a cell doesn't exist |
| boolean | $calculateFormulas | Should formulas be calculated? |
| boolean | $formatData | Should formatting be applied to cell values? |
| boolean | $returnCellRef | False - 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 |
getRowIterator(integer $startRow = 1) : \PHPExcel_Worksheet_RowIterator
Get row iterator
| integer | $startRow | The row number at which to start iterating |
garbageCollect() : \PHPExcel_Worksheet
Run PHPExcel garabage collector.
extractSheetTitle(string $pRange, boolean $returnRange = false) : mixed
Extract worksheet title from range.
Example: extractSheetTitle("testSheet!A1") ==> 'A1' Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1');
| string | $pRange | Range to extract title from |
| boolean | $returnRange | Return range? (see example) |
setHyperlink(string $pCellCoordinate = 'A1', \PHPExcel_Cell_Hyperlink $pHyperlink = null) : \PHPExcel_Worksheet
Set hyperlnk
| string | $pCellCoordinate | Cell coordinate to insert hyperlink |
| \PHPExcel_Cell_Hyperlink | $pHyperlink |
getHyperlinkCollection() : array<mixed,\PHPExcel_Cell_Hyperlink>
Get collection of hyperlinks
setDataValidation(string $pCellCoordinate = 'A1', \PHPExcel_Cell_DataValidation $pDataValidation = null) : \PHPExcel_Worksheet
Set data validation
| string | $pCellCoordinate | Cell coordinate to insert data validation |
| \PHPExcel_Cell_DataValidation | $pDataValidation |
getDataValidationCollection() : array<mixed,\PHPExcel_Cell_DataValidation>
Get collection of data validations
getTabColor() : \PHPExcel_Style_Color
Get tab color
resetTabColor() : \PHPExcel_Worksheet
Reset tab color
copy() : \PHPExcel_Worksheet
Copy worksheet (!= clone!)