BREAK_NONE
BREAK_NONE = 0
PHPExcel_Worksheet
$_invalidCharacters : array
Invalid characters in sheet title
$_parent : \PHPExcel
Parent spreadsheet
$_rowDimensions : \PHPExcel_Worksheet_RowDimension[]
Collection of row dimensions
$_defaultRowDimension : \PHPExcel_Worksheet_RowDimension
Default row dimension
$_columnDimensions : \PHPExcel_Worksheet_ColumnDimension[]
Collection of column dimensions
$_defaultColumnDimension : \PHPExcel_Worksheet_ColumnDimension
Default column dimension
$_drawingCollection : \PHPExcel_Worksheet_BaseDrawing[]
Collection of drawings
$_chartCollection : \PHPExcel_Chart[]
Collection of Chart objects
$_title : string
Worksheet title
$_sheetState : string
Sheet state
$_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 : \PHPExcel_Style[]
Collection of styles
$_conditionalStylesCollection : array
Conditional styles. Indexed by cell coordinate, e.g. 'A1'
$_cellCollectionIsSorted : bool
Is the current cell collection sorted already?
$_breaks : array
Collection of breaks
$_mergeCells : array
Collection of merged cell ranges
$_protectedCells : array
Collection of protected cell ranges
$_autoFilter : \PHPExcel_Worksheet_AutoFilter
Autofilter Range and selection
$_freezePane : string
Freeze pane
$_showGridlines : bool
Show gridlines?
$_printGridlines : bool
Print gridlines?
$_showRowColHeaders : bool
Show row and column headers?
$_showSummaryBelow : bool
Show summary below? (Row/Column outline)
$_showSummaryRight : bool
Show summary right? (Row/Column outline)
$_comments : \PHPExcel_Comment[]
Collection of comments
$_activeCell : string
Active cell. (Only one!)
$_selectedCells : string
Selected cells
$_cachedHighestColumn : string
Cached highest column
$_cachedHighestRow : int
Cached highest row
$_rightToLeft : bool
Right-to-left?
$_hyperlinkCollection : array
Hyperlinks. Indexed by cell coordinate, e.g. 'A1'
$_dataValidationCollection : array
Data validation objects. Indexed by cell coordinate, e.g. 'A1'
$_tabColor : \PHPExcel_Style_Color
Tab color
$_dirty : bool
Dirty flag
$_hash : string
Hash
$_codeName : string
CodeName
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 |
getHighestDataColumn(string $row = null) : string
Get highest worksheet column that contains data
| string | $row | Return the highest data column for the specified row, or the highest data column of any row if no row number is passed |
Highest column name that contains data
getHighestDataRow(string $column = null) : string
Get highest worksheet row that contains data
| string | $column | Return the highest data row for the specified column, or the highest data row of any column if no column letter is passed |
Highest row number that contains data
setCellValue(string $pCoordinate = 'A1', mixed $pValue = null, bool $returnCell = false) : \PHPExcel_Worksheet|\PHPExcel_Cell
Set a cell value
| string | $pCoordinate | Coordinate of the cell |
| mixed | $pValue | Value of the cell |
| bool | $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, bool $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 |
| bool | $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, bool $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 |
| bool | $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, bool $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 |
| bool | $returnCell | Return the worksheet (false, default) or the cell (true) |
Depending on the last parameter being specified
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
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 = '', bool $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") |
| bool | $pAdvanced | Advanced mode for setting borders. |
setBreakByColumnAndRow(int $pColumn, int $pRow = 1, int $pBreak = PHPExcel_Worksheet::BREAK_NONE) : \PHPExcel_Worksheet
Set break on a cell by using numeric cell coordinates
| int | $pColumn | Numeric column coordinate of the cell |
| int | $pRow | Numeric row coordinate of the cell |
| int | $pBreak | Break type (type of PHPExcel_Worksheet::BREAK_*) |
mergeCellsByColumnAndRow(int $pColumn1, int $pRow1 = 1, int $pColumn2, int $pRow2 = 1) : \PHPExcel_Worksheet
Set merge on a cell range by using numeric cell coordinates
| int | $pColumn1 | Numeric column coordinate of the first cell |
| int | $pRow1 | Numeric row coordinate of the first cell |
| int | $pColumn2 | Numeric column coordinate of the last cell |
| int | $pRow2 | Numeric row coordinate of the last cell |
unmergeCellsByColumnAndRow(int $pColumn1, int $pRow1 = 1, int $pColumn2, int $pRow2 = 1) : \PHPExcel_Worksheet
Remove merge on a cell range by using numeric cell coordinates
| int | $pColumn1 | Numeric column coordinate of the first cell |
| int | $pRow1 | Numeric row coordinate of the first cell |
| int | $pColumn2 | Numeric column coordinate of the last cell |
| int | $pRow2 | Numeric row coordinate of the last cell |
protectCells(string $pRange = 'A1', string $pPassword = '', bool $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 |
| bool | $pAlreadyHashed | If the password has already been hashed, set this to true |
protectCellsByColumnAndRow(int $pColumn1, int $pRow1 = 1, int $pColumn2, int $pRow2 = 1, string $pPassword = '', bool $pAlreadyHashed = false) : \PHPExcel_Worksheet
Set protection on a cell range by using numeric cell coordinates
| int | $pColumn1 | Numeric column coordinate of the first cell |
| int | $pRow1 | Numeric row coordinate of the first cell |
| int | $pColumn2 | Numeric column coordinate of the last cell |
| int | $pRow2 | Numeric row coordinate of the last cell |
| string | $pPassword | Password to unlock the protection |
| bool | $pAlreadyHashed | If the password has already been hashed, set this to true |
unprotectCellsByColumnAndRow(int $pColumn1, int $pRow1 = 1, int $pColumn2, int $pRow2 = 1, string $pPassword = '', bool $pAlreadyHashed = false) : \PHPExcel_Worksheet
Remove protection on a cell range by using numeric cell coordinates
| int | $pColumn1 | Numeric column coordinate of the first cell |
| int | $pRow1 | Numeric row coordinate of the first cell |
| int | $pColumn2 | Numeric column coordinate of the last cell |
| int | $pRow2 | Numeric row coordinate of the last cell |
| string | $pPassword | Password to unlock the protection |
| bool | $pAlreadyHashed | If the password has already been hashed, set this to true |
setAutoFilter(mixed $pValue) : mixed
Set AutoFilter
@param PHPExcel_Worksheet_AutoFilter|string $pValue A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
| mixed | $pValue |
@return PHPExcel_Worksheet
setAutoFilterByColumnAndRow(mixed $pColumn1, int $pRow1 = 1, mixed $pColumn2, mixed $pRow2 = 1) : mixed
Set Autofilter Range by using numeric cell coordinates
@param integer $pColumn1 Numeric column coordinate of the first cell
| mixed | $pColumn1 | |
| int | $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 |
| mixed | $pColumn2 | |
| mixed | $pRow2 |
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(int $pColumn, int $pRow = 1) : \PHPExcel_Worksheet
Freeze Pane by using numeric cell coordinates
| int | $pColumn | Numeric column coordinate of the cell |
| int | $pRow | Numeric row coordinate of the cell |
insertNewColumnBefore(int $pBefore = 'A', int $pNumCols = 1) : \PHPExcel_Worksheet
Insert a new column, updating all possible related data
| int | $pBefore | Insert before this one |
| int | $pNumCols | Number of columns to insert |
insertNewColumnBeforeByIndex(int $pBefore, int $pNumCols = 1) : \PHPExcel_Worksheet
Insert a new column, updating all possible related data
| int | $pBefore | Insert before this one (numeric column coordinate of the cell) |
| int | $pNumCols | Number of columns to insert |
removeColumnByIndex(int $pColumn, int $pNumCols = 1) : \PHPExcel_Worksheet
Remove a column, updating all possible related data
| int | $pColumn | Remove starting with this one (numeric column coordinate of the cell) |
| int | $pNumCols | Number of columns to remove |
setSelectedCellByColumnAndRow(int $pColumn, int $pRow = 1) : \PHPExcel_Worksheet
Selected cell by using numeric cell coordinates
| int | $pColumn | Numeric column coordinate of the cell |
| int | $pRow | Numeric row coordinate of the cell |
fromArray(array $source = null, mixed $nullValue = null, string $startCell = 'A1', bool $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 |
| bool | $strictNullComparison | Apply strict comparison when testing for null values in the array |
rangeToArray(string $pRange = 'A1', mixed $nullValue = null, bool $calculateFormulas = true, bool $formatData = true, bool $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 |
| bool | $calculateFormulas | Should formulas be calculated? |
| bool | $formatData | Should formatting be applied to cell values? |
| bool | $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, bool $calculateFormulas = true, bool $formatData = true, bool $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 |
| bool | $calculateFormulas | Should formulas be calculated? |
| bool | $formatData | Should formatting be applied to cell values? |
| bool | $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, bool $calculateFormulas = true, bool $formatData = true, bool $returnCellRef = false) : array
Create array from worksheet
| mixed | $nullValue | Value returned in the array entry if a cell doesn't exist |
| bool | $calculateFormulas | Should formulas be calculated? |
| bool | $formatData | Should formatting be applied to cell values? |
| bool | $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 |
extractSheetTitle(string $pRange, bool $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 |
| bool | $returnRange | Return range? (see example) |
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 |