JSON API documentation
JSON API documentation
Please refer to the JSON API introduction page to learn more about this functionality.
You will find in this section a complete list of the actions included in the JSON API feature of the latest version of the phpxlsx library.
-
addBreak
Inserts a break
-
addCell
Inserts a cell content
-
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
-
addHeader
Inserts a header
-
addFunction
Inserts a function
-
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
-
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
-
mergeCells
Merges cells
-
setActiveSheet
Sets the internal active sheet
-
setColumnSettings
Sets column settings
-
setMarkAsFinal
Marks the Excel output as final
-
setRowSettings
Sets row settings
-
setRtl
Sets the global right to left language properties
-
setSheetSettings
Sets sheet settings
-
setWorkbookSettings
Sets workbook settings
-
unmergeCells
Unmerges cells
-
getTemplateVariables
Returns the template placeholder variables as an array
-
getTemplateVariablesType
Returns the template placeholder variables and their types
-
setTemplateSymbol
Sets custom symbols to wrap phpxlsx template variables
-
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
-
transform
Transforms files into other formats (XLSX, PDF, XLS, ODS)
-
getXlsxPathQueryInfo
Gets information from a performed XlsxPath query
-
moveElement
Moves elements in the spreadsheet
-
removeElement
Removes elements in the spreadsheet
-
watermark
Inserts a watermark into an Excel spreadsheet
-
zipStream
Generates an XLSX stream without saving the document to the file system