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.

Here we include a brief description of each method for your convenience:

Contents

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

Layouts

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

Settings

addProperties
Adds properties
docxSettings
Sets DOCX settings

Styles

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

Templates

getTemplateSymbols
Gets template symbols
getTemplateVariables
Gets template variables
openTemplate
Opens a 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 a DOCX