Class: PHPExcel_Worksheet
Source Location: /PHPExcel/Worksheet.php
PHPExcel_Worksheet
Author(s):
Copyright:
- Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
Implements interfaces:
|
|
|
Class Details
Class Methods
static method extractSheetTitle [line 2564]
static mixed extractSheetTitle(
string
$pRange, [bool
$returnRange = false])
|
|
Extract worksheet title from range. Example: extractSheetTitle("testSheet!A1") ==> 'A1' Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1');
Tags:
Parameters:
static method getInvalidCharacters [line 400]
static array getInvalidCharacters(
)
|
|
Get array of invalid characters for sheet title
Tags:
method addChart [line 526]
PHPExcel_Chart addChart(
[PHPExcel_Chart
$pChart = null], [int|null
$iChartIndex = null])
|
|
Add chart
Tags:
Parameters:
constructor __construct [line 334]
PHPExcel_Worksheet __construct(
[PHPExcel
$pParent = null], [string
$pTitle = 'Worksheet'])
|
|
Create a new worksheet
Tags:
Parameters:
method calculateColumnWidths [line 674]
PHPExcel_Worksheet; calculateColumnWidths(
[boolean
$calculateMergeCells = false])
|
|
Calculate widths for auto-size columns
Tags:
Parameters:
method calculateWorksheetDataDimension [line 662]
string calculateWorksheetDataDimension(
)
|
|
Calculate worksheet data dimension
Tags:
method calculateWorksheetDimension [line 651]
string calculateWorksheetDimension(
)
|
|
Calculate worksheet dimension
Tags:
method cellExists [line 1182]
boolean cellExists(
[string
$pCoordinate = 'A1'])
|
|
Cell at a specific coordinate exists?
Tags:
Parameters:
method cellExistsByColumnAndRow [line 1229]
boolean cellExistsByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 1])
|
|
Cell at a specific coordinate by using numeric cell coordinates exists?
Tags:
Parameters:
method conditionalStylesExists [line 1365]
boolean conditionalStylesExists(
[string
$pCoordinate = 'A1'])
|
|
Do conditional styles exist for this cell?
Tags:
Parameters:
method copy [line 2758]
Copy worksheet (!= clone!)
Tags:
method dataValidationExists [line 2674]
boolean dataValidationExists(
[string
$pCoordinate = 'A1'])
|
|
Data validation at a specific coordinate exists?
Tags:
Parameters:
method disconnectCells [line 377]
Disconnect all cells from this PHPExcel_Worksheet object, typically so that the worksheet object can be unset
Tags:
method duplicateConditionalStyle [line 1511]
PHPExcel_Worksheet duplicateConditionalStyle(
[array
$pCellStyle = null], [string
$pRange = ''])
|
|
Duplicate conditional style to a range of cells Please note that this will overwrite existing cell styles for cells in range!
Tags:
Parameters:
method duplicateStyle [line 1447]
PHPExcel_Worksheet duplicateStyle(
[PHPExcel_Style
$pCellStyle = null], [string
$pRange = ''])
|
|
Duplicate cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!
Tags:
Parameters:
method duplicateStyleArray [line 1571]
PHPExcel_Worksheet duplicateStyleArray(
[array
$pStyles = null], [string
$pRange = ''], [boolean
$pAdvanced = true])
|
|
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.
Tags:
Parameters:
method freezePane [line 1908]
Freeze Pane
Tags:
Parameters:
method freezePaneByColumnAndRow [line 1929]
Freeze Pane by using numeric cell coordinates
Tags:
Parameters:
method fromArray [line 2334]
PHPExcel_Worksheet fromArray(
[array
$source = null], [mixed
$nullValue = null], [string
$startCell = 'A1'], [boolean
$strictNullComparison = false])
|
|
Fill worksheet from values in array
Tags:
Parameters:
method garbageCollect [line 2500]
Run PHPExcel garabage collector.
Tags:
method getActiveCell [line 2231]
method getAutoFilter [line 1835]
Get Autofilter Range
Tags:
method getBreaks [line 1618]
method getCell [line 1085]
Get cell at a specific coordinate
Tags:
Parameters:
method getCellByColumnAndRow [line 1155]
PHPExcel_Cell getCellByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 1])
|
|
Get cell at a specific coordinate by using numeric cell coordinates
Tags:
Parameters:
method getCellCacheController [line 390]
PHPExcel_CachedObjectStorage_xxx getCellCacheController(
)
|
|
Return the cache controller for the cell collection
Tags:
method getCellCollection [line 433]
PHPExcel_Cell[] getCellCollection(
[boolean
$pSorted = true])
|
|
Get collection of cells
Tags:
Parameters:
method getChartByIndex [line 556]
Get a chart by its index position
Tags:
Parameters:
method getChartByName [line 594]
Get a chart by name
Tags:
Parameters:
method getChartCollection [line 513]
PHPExcel_Chart[] getChartCollection(
)
|
|
Get collection of charts
Tags:
method getChartCount [line 544]
Return the count of charts on this worksheet
Tags:
method getChartNames [line 578]
string[] getChartNames(
)
|
|
Return an array of the names of charts on this worksheet
Tags:
method getColumnDimension [line 1260]
Get column dimension at a specific column
Tags:
Parameters:
method getColumnDimensionByColumn [line 1281]
Get column dimension at a specific column by using numeric cell coordinates
Tags:
Parameters:
method getColumnDimensions [line 483]
PHPExcel_Worksheet_ColumnDimension[] getColumnDimensions(
)
|
|
Get collection of column dimensions
Tags:
method getComment [line 2179]
Get comment for cell
Tags:
Parameters:
method getCommentByColumnAndRow [line 2210]
Get comment for cell by using numeric cell coordinates
Tags:
Parameters:
method getComments [line 2154]
PHPExcel_Comment[] getComments(
)
|
|
Get comments
Tags:
method getConditionalStyles [line 1351]
PHPExcel_Style_Conditional[] getConditionalStyles(
[string
$pCoordinate = 'A1'])
|
|
Get conditional styles for a cell
Tags:
Parameters:
method getConditionalStylesCollection [line 1390]
array getConditionalStylesCollection(
)
|
|
Get collection of conditional styles
Tags:
method getDataValidation [line 2639]
void getDataValidation(
[string
$pCellCoordinate = 'A1'])
|
|
Get data validation
Tags:
Parameters:
method getDataValidationCollection [line 2684]
PHPExcel_Cell_DataValidation[] getDataValidationCollection(
)
|
|
Get collection of data validations
Tags:
method getDefaultColumnDimension [line 493]
Get default column dimension
Tags:
method getDefaultRowDimension [line 473]
Get default row dimension
Tags:
method getDefaultStyle [line 1303]
Get default style of workbork.
Tags:
method getDrawingCollection [line 503]
PHPExcel_Worksheet_BaseDrawing[] getDrawingCollection(
)
|
|
Get collection of drawings
Tags:
method getFreezePane [line 1896]
method getHashCode [line 2542]
method getHeaderFooter [line 899]
Get page header/footer
Tags:
method getHighestColumn [line 967]
string getHighestColumn(
)
|
|
Get highest worksheet column
Tags:
method getHighestDataColumn [line 977]
string getHighestDataColumn(
)
|
|
Get highest worksheet column that contains data
Tags:
method getHighestDataRow [line 997]
string getHighestDataRow(
)
|
|
Get highest worksheet row that contains data
Tags:
method getHighestRow [line 987]
Get highest worksheet row
Tags:
method getHighestRowAndColumn [line 1007]
array getHighestRowAndColumn(
)
|
|
Get highest worksheet column and highest row that have cell records
Tags:
method getHyperlink [line 2584]
void getHyperlink(
[string
$pCellCoordinate = 'A1'])
|
|
Get hyperlink
Tags:
Parameters:
method getHyperlinkCollection [line 2629]
PHPExcel_Cell_Hyperlink[] getHyperlinkCollection(
)
|
|
Get collection of hyperlinks
Tags:
method getMergeCells [line 1724]
Get merge cells array.
Tags:
method getPageMargins [line 877]
method getPageSetup [line 855]
method getParent [line 735]
method getPrintGridlines [line 2074]
boolean getPrintGridlines(
)
|
|
Print gridlines?
Tags:
method getProtectedCells [line 1825]
array[] getProtectedCells(
)
|
|
Get protected cells
Tags:
method getProtection [line 943]
method getRightToLeft [line 2309]
boolean getRightToLeft(
)
|
|
Get right-to-left
Tags:
method getRowDimension [line 1240]
Get row dimension at a specific row
Tags:
Parameters:
method getRowDimensions [line 463]
PHPExcel_Worksheet_RowDimension[] getRowDimensions(
)
|
|
Get collection of row dimensions
Tags:
method getRowIterator [line 2491]
Get row iterator
Tags:
Parameters:
method getSelectedCell [line 2221]
string getSelectedCell(
)
|
|
Get selected cell
Tags:
method getSelectedCells [line 2241]
string getSelectedCells(
)
|
|
Get selected cells
Tags:
method getSheetState [line 835]
method getSheetView [line 921]
method getShowGridlines [line 2054]
boolean getShowGridlines(
)
|
|
Show gridlines?
Tags:
method getShowRowColHeaders [line 2094]
boolean getShowRowColHeaders(
)
|
|
Show row and column headers?
Tags:
method getShowSummaryBelow [line 2114]
boolean getShowSummaryBelow(
)
|
|
Show summary below? (Row/Column outlining)
Tags:
method getShowSummaryRight [line 2134]
boolean getShowSummaryRight(
)
|
|
Show summary right? (Row/Column outlining)
Tags:
method getStyle [line 1334]
Get style for cell
Tags:
Parameters:
method getStyleByColumnAndRow [line 1415]
PHPExcel_Style getStyleByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 1])
|
|
Get style for cell by using numeric cell coordinates
Tags:
Parameters:
method getStyles [line 1291]
PHPExcel_Style[] getStyles(
)
|
|
Get styles
Tags:
method getTabColor [line 2722]
method getTitle [line 764]
method hyperlinkExists [line 2619]
boolean hyperlinkExists(
[string
$pCoordinate = 'A1'])
|
|
Hyperlink at a specific coordinate exists?
Tags:
Parameters:
method insertNewColumnBefore [line 1970]
Insert a new column, updating all possible related data
Tags:
Parameters:
method insertNewColumnBeforeByIndex [line 1988]
Insert a new column, updating all possible related data
Tags:
Parameters:
method insertNewRowBefore [line 1952]
Insert a new row, updating all possible related data
Tags:
Parameters:
method isTabColorSet [line 2748]
method mergeCells [line 1630]
Set merge on a cell range
Tags:
Parameters:
method mergeCellsByColumnAndRow [line 1672]
PHPExcel_Worksheet mergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 1], [int
$pColumn2 = 0], [int
$pRow2 = 1])
|
|
Set merge on a cell range by using numeric cell coordinates
Tags:
Parameters:
method namedRangeToArray [line 2449]
array namedRangeToArray(
[string
$pNamedRange = ''], [mixed
$nullValue = null], [boolean
$calculateFormulas = true], [boolean
$formatData = true], [boolean
$returnCellRef = false])
|
|
Create array from a range of cells
Tags:
Parameters:
method protectCells [line 1751]
PHPExcel_Worksheet protectCells(
[string
$pRange = 'A1'], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])
|
|
Set protection on a cell range
Tags:
Parameters:
method protectCellsByColumnAndRow [line 1776]
PHPExcel_Worksheet protectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 1], [int
$pColumn2 = 0], [int
$pRow2 = 1], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])
|
|
Set protection on a cell range by using numeric cell coordinates
Tags:
Parameters:
method rangeToArray [line 2380]
array rangeToArray(
[string
$pRange = 'A1'], [mixed
$nullValue = null], [boolean
$calculateFormulas = true], [boolean
$formatData = true], [boolean
$returnCellRef = false])
|
|
Create array from a range of cells
Tags:
Parameters:
method rebindParent [line 745]
Re-bind parent
Tags:
Parameters:
method refreshColumnDimensions [line 613]
Refresh column dimensions
Tags:
method refreshRowDimensions [line 632]
Refresh row dimensions
Tags:
method removeAutoFilter [line 1885]
method removeColumn [line 2022]
Remove a column, updating all possible related data
Tags:
Parameters:
method removeColumnByIndex [line 2041]
Remove a column, updating all possible related data
Tags:
Parameters:
method removeConditionalStyles [line 1379]
Removes conditional styles for a cell
Tags:
Parameters:
method removeRow [line 2004]
Delete a row, updating all possible related data
Tags:
Parameters:
method resetTabColor [line 2735]
method setAutoFilter [line 1847]
Set Autofilter Range
Tags:
Parameters:
method setAutoFilterByColumnAndRow [line 1871]
PHPExcel_Worksheet setAutoFilterByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 1], [int
$pColumn2 = 0], [int
$pRow2 = 1])
|
|
Set Autofilter Range by using numeric cell coordinates
Tags:
Parameters:
method setBreak [line 1585]
PHPExcel_Worksheet setBreak(
[string
$pCell = 'A1'], [int
$pBreak = PHPExcel_Worksheet::BREAK_NONE])
|
|
Set break on a cell
Tags:
Parameters:
method setBreakByColumnAndRow [line 1608]
PHPExcel_Worksheet setBreakByColumnAndRow(
[integer
$pColumn = 0], [integer
$pRow = 1], [integer
$pBreak = PHPExcel_Worksheet::BREAK_NONE])
|
|
Set break on a cell by using numeric cell coordinates
Tags:
Parameters:
method setCellValue [line 1020]
Set a cell value
Tags:
Parameters:
method setCellValueByColumnAndRow [line 1039]
PHPExcel_Worksheet|PHPExcel_Cell setCellValueByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 1], [mixed
$pValue = null], [bool
$returnCell = false])
|
|
Set a cell value by using numeric cell coordinates
Tags:
Parameters:
method setCellValueExplicit [line 1057]
PHPExcel_Worksheet setCellValueExplicit(
[string
$pCoordinate = 'A1'], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])
|
|
Set a cell value
Tags:
Parameters:
method setCellValueExplicitByColumnAndRow [line 1073]
PHPExcel_Worksheet setCellValueExplicitByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 1], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])
|
|
Set a cell value by using numeric cell coordinates
Tags:
Parameters:
method setComments [line 2165]
Set comments array for the entire sheet.
Tags:
Parameters:
method setConditionalStyles [line 1402]
PHPExcel_Worksheet setConditionalStyles(
[$pCoordinate
$pCoordinate = 'A1'], $pValue
$pValue)
|
|
Set conditional styles
Tags:
Parameters:
method setDataValidation [line 2658]
PHPExcel_Worksheet setDataValidation(
[string
$pCellCoordinate = 'A1'], [PHPExcel_Cell_DataValidation
$pDataValidation = null])
|
|
Set data validation
Tags:
Parameters:
method setDefaultStyle [line 1316]
Set default style - should only be used by PHPExcel_IReader implementations!
Tags:
Parameters:
method setHeaderFooter [line 910]
Set page header/footer
Tags:
Parameters:
method setHyperlink [line 2603]
PHPExcel_Worksheet setHyperlink(
[string
$pCellCoordinate = 'A1'], [PHPExcel_Cell_Hyperlink
$pHyperlink = null])
|
|
Set hyperlnk
Tags:
Parameters:
method setMergeCells [line 1735]
void setMergeCells(
[array
$pValue = array()])
|
|
Set merge cells array for the entire sheet. Use instead mergeCells() to merge a single cell range.
Tags:
Parameters:
method setPageMargins [line 888]
Set page margins
Tags:
Parameters:
method setPageSetup [line 866]
Set page setup
Tags:
Parameters:
method setPrintGridlines [line 2084]
Set print gridlines
Tags:
Parameters:
method setProtection [line 954]
Set Protection
Tags:
Parameters:
method setRightToLeft [line 2319]
Set right-to-left
Tags:
Parameters:
method setSelectedCell [line 2252]
Selected cell
Tags:
Parameters:
method setSelectedCellByColumnAndRow [line 2299]
Selected cell by using numeric cell coordinates
Tags:
Parameters:
method setSelectedCells [line 2264]
Select a range of cells.
Tags:
Parameters:
method setSharedStyle [line 1431]
PHPExcel_Worksheet setSharedStyle(
[PHPExcel_Style
$pSharedCellStyle = null], [string
$pRange = ''])
|
|
Set shared cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!
Tags:
Parameters:
method setSheetState [line 845]
PHPExcel_Worksheet setSheetState(
[string
$value = PHPExcel_Worksheet::SHEETSTATE_VISIBLE])
|
|
Set sheet state
Tags:
Parameters:
method setSheetView [line 932]
Set sheet view
Tags:
Parameters:
method setShowGridlines [line 2064]
Set show gridlines
Tags:
Parameters:
method setShowRowColHeaders [line 2104]
Set show row and column headers
Tags:
Parameters:
method setShowSummaryBelow [line 2124]
Set show summary below
Tags:
Parameters:
method setShowSummaryRight [line 2144]
Set show summary right
Tags:
Parameters:
method setTitle [line 780]
PHPExcel_Worksheet setTitle(
[string
$pValue = 'Worksheet'], [string
$updateFormulaCellReferences = true])
|
|
Set title
Tags:
Parameters:
method shrinkRangeToFit [line 2695]
string shrinkRangeToFit(
string
$range)
|
|
Accepts a range, returning it as a range that falls within the current highest row and column of the worksheet
Tags:
Parameters:
method sortCellCollection [line 450]
Sort collection of cells
Tags:
method toArray [line 2473]
array toArray(
[mixed
$nullValue = null], [boolean
$calculateFormulas = true], [boolean
$formatData = true], [boolean
$returnCellRef = false])
|
|
Create array from worksheet
Tags:
Parameters:
method unfreezePane [line 1939]
method unmergeCells [line 1685]
Remove merge on a cell range
Tags:
Parameters:
method unmergeCellsByColumnAndRow [line 1713]
PHPExcel_Worksheet unmergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 1], [int
$pColumn2 = 0], [int
$pRow2 = 1])
|
|
Remove merge on a cell range by using numeric cell coordinates
Tags:
Parameters:
method unprotectCells [line 1789]
Remove protection on a cell range
Tags:
Parameters:
method unprotectCellsByColumnAndRow [line 1814]
PHPExcel_Worksheet unprotectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 1], [int
$pColumn2 = 0], [int
$pRow2 = 1], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])
|
|
Remove protection on a cell range by using numeric cell coordinates
Tags:
Parameters:
method __clone [line 2767]
Implement PHP __clone to create a deep clone, not just a shallow copy.
Tags:
Class Constants
|
|