API documentation
API documentation
You will find in this section a complete list of the methods included in the latest version of the phpxlsx library.
Here we include a brief description of each method for your convenience:
-
addBreak
Inserts a break
-
addCell
Inserts a cell content
-
addCellRange
Inserts a range of cell contents
-
addChart
Inserts a chart
-
addComment
Inserts a comment
-
addCommentAuthor
Inserts a comment author
-
addCsv
Imports a CSV
-
addDefinedName
Inserts a defined name
-
addFooter
Inserts a footer
-
addFunction
Inserts a function
-
addHeader
Inserts a header
-
addHtml
Inserts HTML content
-
addImage
Inserts an image
-
addLink
Inserts a link
-
addMathEquation
Inserts a math equation
-
addShape
Inserts a shape
-
addSheet
Inserts a sheet
-
addSvg
Inserts a SVG
-
addTable
Inserts a table
-
addTextBox
Inserts a text box
-
getCell
Returns information from a cell
-
removeCell
Removes a cell
-
setCellValue
Sets a cell value keeping existing styles
-
addBackgroundImage
Inserts a background image
-
addMacroFromXlsx
Inserts a macro from an XLSX
-
addProperties
Modifies the properties of the Excel document
-
createCellStyle
Creates a cell style
-
createTableStyle
Creates a table style
-
getActiveSheet
Gets the internal active sheet
-
getCellPositions
Gets existing cell positions from the active sheet
-
getColumnSettings
Gets column settings
-
getRowSettings
Gets row settings
-
setActiveSheet
Sets the internal active sheet
-
setColumnSettings
Sets column settings
-
setMarkAsFinal
Marks the Excel output as final
-
setRowSettings
Modifies the properties
-
setRtl
Sets the global right to left language properties
-
setSheetSettings
Sets sheet settings
-
setWorkbookSettings
Sets workbook settings
-
getTemplateVariables
Returns the template placeholder variables as an array
-
removeVariableImage
Removes image template variables
-
removeVariableText
Removes template variables
-
replaceVariableImage
Replaces image variables with a new image
-
replaceVariableText
Replaces an array of variables with their values
-
setTemplateSymbol
Sets custom symbols to wrap phpxlsx template variables
-
saveXlsx
Saves the XLSX spreadsheet
-
saveXlsxAndDownload
Saves and downloads the XLSX spreadsheet
-
transform
Transforms files into other formats (XLSX, PDF, XLS, ODS)
-
searchAndReplace
Searches and replaces shared strings and cell values
-
split
Splits XLSX documents per sheet
-
indexer
Parses XLSX files and return contents and information
-
zipStream
Generates an XLSX stream without saving the document to the file system
-
encrypt
Encrypts an Excel (XLSX) document
-
protect
Password protects the contents of an Excel document
-
removeProtection
Removes the password protection from an Excel document
-
sign (XLSX)
Digitally signs an XLSX file