Class: Spreadsheet_Excel_Writer_Worksheet
Source Location: /Spreadsheet_Excel_Writer-0.9.3/Spreadsheet/Excel/Writer/Worksheet.php
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
activate [line 749]
Set this worksheet as the active worksheet, i.e. the worksheet that is displayed when the workbook is opened. Also set it as selected.
centerHorizontally [line 948]
void centerHorizontally(
[integer
$center = 1])
|
|
Center the page horinzontally.
Parameters:
centerVertically [line 959]
void centerVertically(
[integer
$center = 1])
|
|
Center the page vertically.
Parameters:
close [line 538]
void close(
array
$sheetnames)
|
|
Add data to the beginning of the workbook (note the reverse order) and to the end of the workbook.
Parameters:
fitToPages [line 1138]
void fitToPages(
integer
$width, integer
$height)
|
|
Set the vertical and horizontal number of pages that will define the maximum area printed. It doesn't seem to work with OpenOffice.
Parameters:
freezePanes [line 853]
void freezePanes(
array
$panes)
|
|
Set panes and mark them as frozen.
Parameters:
getData [line 678]
Retrieves data from memory in one chunk, or from disk in $buffer sized chunks.
getName [line 667]
Retrieve the worksheet name. This is usefull when creating worksheets without a name.
hideGridlines [line 1103]
Set the option to hide gridlines on the printed page.
hideScreenGridlines [line 1113]
void hideScreenGridlines(
)
|
|
Set the option to hide gridlines on the worksheet (as seen on the screen).
insertBitmap [line 3189]
void insertBitmap(
integer
$row, integer
$col, string
$bitmap, [integer
$x = 0], [integer
$y = 0], [integer
$scale_x = 1], [integer
$scale_y = 1])
|
|
Insert a 24bit bitmap image in a worksheet.
Parameters:
mergeCells [line 2877]
void mergeCells(
integer
$first_row, integer
$first_col, integer
$last_row, integer
$last_col)
|
|
Merges the area given by its arguments. This is an Excel97/2000 method. It is required to perform more complicated merging than the normal setAlign('merge').
Parameters:
printArea [line 1089]
void printArea(
integer
$first_row, integer
$first_col, integer
$last_row, integer
$last_col)
|
|
Set the area of each worksheet that will be printed.
Parameters:
printRowColHeaders [line 1124]
void printRowColHeaders(
[integer
$print = 1])
|
|
Set the option to print the row and column headers on the printed page.
Parameters:
protect [line 775]
void protect(
string
$password)
|
|
Set the worksheet protection flag to prevent accidental modification and to hide formulas if the locked and hidden format properties have been set.
Parameters:
repeatColumns [line 1070]
void repeatColumns(
integer
$first_col, [integer
$last_col = null])
|
|
Set the columns to repeat at the left hand side of each printed page.
Parameters:
repeatRows [line 1053]
void repeatRows(
integer
$first_row, [integer
$last_row = null])
|
|
Set the rows to repeat at the top of each printed page.
Parameters:
select [line 737]
Set this worksheet as a selected worksheet, i.e. the worksheet has its tab highlighted.
setColumn [line 792]
void setColumn(
integer
$firstcol, integer
$lastcol, integer
$width, [mixed
$format = null], [integer
$hidden = 0], [integer
$level = 0])
|
|
Set the width of a single column or a range of columns.
Parameters:
setFirstSheet [line 762]
Set this worksheet as the first visible sheet. This is necessary when there are a large number of worksheets and the activated worksheet is not visible on the screen.
setFooter [line 932]
void setFooter(
string
$string, [float
$margin = 0.50])
|
|
Set the page footer caption and optional margin.
Parameters:
setHeader [line 915]
void setHeader(
string
$string, [float
$margin = 0.50])
|
|
Set the page header caption and optional margin.
Parameters:
setHPagebreaks [line 1152]
void setHPagebreaks(
array
$breaks)
|
|
Store the horizontal page breaks on a worksheet (for printing). The breaks represent the row after which the break is inserted.
Parameters:
setInputEncoding [line 1607]
void setInputEncoding(
string
$encoding)
|
|
Sets Input Encoding for writing strings
Parameters:
setLandscape [line 891]
Set the page orientation as landscape.
setMarginBottom [line 1041]
void setMarginBottom(
[float
$margin = 1.00])
|
|
Set the bottom margin in inches.
Parameters:
setMarginLeft [line 1008]
void setMarginLeft(
[float
$margin = 0.75])
|
|
Set the left margin in inches.
Parameters:
setMarginRight [line 1019]
void setMarginRight(
[float
$margin = 0.75])
|
|
Set the right margin in inches.
Parameters:
setMargins [line 970]
void setMargins(
float
$margin)
|
|
Set all the page margins to the same value in inches.
Parameters:
setMargins_LR [line 984]
void setMargins_LR(
float
$margin)
|
|
Set the left and right margins to the same value in inches.
Parameters:
setMargins_TB [line 996]
void setMargins_TB(
float
$margin)
|
|
Set the top and bottom margins to the same value in inches.
Parameters:
setMarginTop [line 1030]
void setMarginTop(
[float
$margin = 1.00])
|
|
Set the top margin in inches.
Parameters:
setMerge [line 712]
void setMerge(
integer
$first_row, integer
$first_col, integer
$last_row, integer
$last_col)
|
|
Sets a merged cell range
Parameters:
setOutline [line 1458]
void setOutline(
[bool
$visible = true], [bool
$symbols_below = true], [bool
$symbols_right = true], [bool
$auto_style = false])
|
|
This method sets the properties for outlining and grouping. The defaults correspond to Excel's defaults.
Parameters:
setPaper [line 902]
void setPaper(
[integer
$size = 0])
|
|
Set the paper type. Ex. 1 = US Letter, 9 = A4
Parameters:
setPortrait [line 881]
Set the page orientation as portrait.
setPrintScale [line 1198]
void setPrintScale(
[integer
$scale = 100])
|
|
Set the scale factor for the printed page. It turns off the "fit to page" option
Parameters:
setRow [line 2216]
void setRow(
integer
$row, integer
$height, [mixed
$format = null], [bool
$hidden = false], [integer
$level = 0])
|
|
This method is used to set the height and format for a row.
Parameters:
setRTL [line 1476]
void setRTL(
[bool
$rtl = true])
|
|
This method sets the worksheet direction to right-to-left (RTL)
Parameters:
setSelection [line 837]
void setSelection(
integer
$first_row, integer
$first_column, integer
$last_row, integer
$last_column)
|
|
Set which cell or cells are selected in a worksheet
Parameters:
setValidation [line 3562]
void setValidation(
$row1,
$col1,
$row2,
$col2,
&$validator)
|
|
FIXME: add comments
Parameters:
setVPagebreaks [line 1166]
void setVPagebreaks(
array
$breaks)
|
|
Store the vertical page breaks on a worksheet (for printing). The breaks represent the column after which the break is inserted.
Parameters:
setZoom [line 1180]
void setZoom(
[integer
$scale = 100])
|
|
Set the worksheet zoom factor.
Parameters:
thawPanes [line 870]
void thawPanes(
array
$panes)
|
|
Set panes and mark them as unfrozen.
Parameters:
write [line 1221]
void write(
integer
$row, integer
$col, mixed
$token, [mixed
$format = null])
|
|
Map to the appropriate write method acording to the token recieved.
Parameters:
writeBlank [line 1775]
void writeBlank(
integer
$row, integer
$col, mixed
$format)
|
|
Write a blank cell to the specified row and column (zero indexed). A blank cell is used to specify formatting without adding a string or a number. A blank cell without a format serves no purpose. Therefore, we don't write a BLANK record unless a format is specified. Returns 0 : normal termination (including no format) -1 : insufficient number of arguments -2 : row or column out of range
Parameters:
writeCol [line 1292]
mixed writeCol(
integer
$row, integer
$col, array
$val, [mixed
$format = null])
|
|
Write an array of values as a column
Parameters:
writeFormula [line 1828]
integer writeFormula(
integer
$row, integer
$col, string
$formula, [mixed
$format = null])
|
|
Write a formula to the specified row and column (zero indexed). The textual representation of the formula is passed to the parser in Parser.php which returns a packed binary string. Returns 0 : normal termination -1 : formula errors (bad formula) -2 : row or column out of range
Parameters:
writeNote [line 1715]
void writeNote(
integer
$row, integer
$col, string
$note)
|
|
Writes a note associated with the cell given by the row and column. NOTE records don't have a length limit.
Parameters:
writeNumber [line 1503]
integer writeNumber(
integer
$row, integer
$col, float
$num, [mixed
$format = null])
|
|
Write a double to the specified row and column (zero indexed). An integer can be written as a double. Excel will display an integer. $format is optional. Returns 0 : normal termination -2 : row or column out of range
Parameters:
writeRow [line 1263]
mixed writeRow(
integer
$row, integer
$col, array
$val, [mixed
$format = null])
|
|
Write an array of values as a row
Parameters:
writeString [line 1556]
integer writeString(
integer
$row, integer
$col, string
$str, [mixed
$format = null])
|
|
Write a string to the specified row and column (zero indexed). NOTE: there is an Excel 5 defined limit of 255 characters. $format is optional. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars
Parameters:
writeStringBIFF8 [line 1630]
integer writeStringBIFF8(
integer
$row, integer
$col, string
$str, [mixed
$format = null])
|
|
Write a string to the specified row and column (zero indexed). This is the BIFF8 version (no 255 chars limit). $format is optional. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars
Parameters:
writeUrl [line 1906]
integer writeUrl(
integer
$row, integer
$col, string
$url, [string
$string = ''], [mixed
$format = null])
|
|
Write a hyperlink. This is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative string is specified. The label is written using the writeString() method. Therefore the 255 characters string limit applies. $string and $format are optional. The hyperlink can be to a http, ftp, mail, internal sheet (not yet), or external directory url. Returns 0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:47:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|