API documentation

The complete list of jsdocuments methods.

JavaScript API documentation

You will find in this section a complete list of the methods included in the latest version of the jsdocuments library.

DOCX documents

Contents

addBookmark
Adds bookmark
addBreak
Adds break
addComment
Adds comment
addCrossReference
Adds cross-reference
addDateTime
Adds date and time
addEndnote
Adds endnote
addExternalFile
Adds external file
addFootnote
Adds footnote
addFormElement
Adds form element
addImage
Adds image
addLink
Adds link
addList
Adds list
addMathEquation
Adds math equation
addMergeField
Adds merge field
addPageNumber
Adds page numbers
addSimpleField
Adds simple field
addStructuredDocumentTag
Adds structured document tag
addSvg
Adds SVG
addTab
Adds tab
addTable
Adds table
addTableOfContents
Adds table of contents
addTableOfFigures
Adds table of figures
addText
Adds text
addTextBox
Adds text box
addWordFragment
Adds WordFragment
addWordMl
Adds WordML

Layouts

addBackgroundImage
Adds background image
addFooter
Adds footer
addHeader
Adds header
addSection
Adds section
modifySectionLayout
Modifies section layout
setBackgroundColor
Sets background color
setRtl
Sets RTL

Settings

addProperties
Adds properties
docxSettings
Sets DOCX settings

Styles

createCharacterStyle
Creates character style
createListStyle
Creates list style
createParagraphStyle
Creates paragraph style
createTableStyle
Creates table style

Templates

getTemplateSymbols
Gets template symbols
getTemplateVariables
Gets template variables
openTemplate
Opens DOCX template
processTemplate
Processes the template to repair all variables
removeVariableImage
Removes image variables
removeVariableText
Removes text variables
replaceVariableCheckbox
Replaces checkbox variables
replaceVariableExternalFile
Replaces text variables with external files
replaceVariableImage
Replaces image variables
replaceVariableInputField
Replaces input field variables
replaceVariableList
Replaces list variables
replaceVariableTable
Replaces table variables
replaceVariableText
Replaces text variables with text contents
replaceVariableWordFragment
Replaces text variables with WordFragment
replaceVariableWordMl
Replaces text variables with WordML
setTemplateSymbols
Sets template symbols

Others

convertMeasuringUnit
Converts measuring unit
save
Saves DOCX

XLSX spreadsheets

Contents

addBreak
Adds break
addCell
Adds cell
addFunction
Adds function
addImage
Adds image
addLink
Adds link
addSheet
Adds sheet
getCell
Gets cell
removeCell
Removes cell
setCellValue
Sets cell value

Layouts

getActiveSheet
Gets active sheet
getCellPositions
Gets cell positions
setActiveSheet
Sets active sheet
setRtl
Sets RTL

Settings

addProperties
Adds properties
setColumnSettings
Sets column settings
setRowSettings
Sets row settings
setSheetSettings
Sets sheet settings
setWorkbookSettings
Sets workbook settings

Templates

getTemplateVariables
Gets template variables
openTemplate
Opens XLSX template
removeVariableImage
Removes image variables
removeVariableText
Removes text variables
replaceVariableImage
Replaces image variables
replaceVariableText
Replaces text variables with text contents
setTemplateSymbols
Sets template symbols

Others

convertMeasuringUnit
Converts measuring unit
save
Saves XLSX