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 phpdocx library.

Contents
  • addBarcode

    Inserts a barcode field into the Word document

  • addBookmark

    Inserts a bookmarks into the Word document

  • addBreak

    Inserts a line/column/page break into the Word document

  • addCaption

    Inserts a caption into the Word document

  • addChart

    Inserts a chart into the Word document

  • addComment

    Inserts a comment to the current Word document

  • addCrossReference

    Inserts a cross-reference into the Word document

  • addDateAndHour

    Insert a date and/or hour in different formats

  • addDropCap

    Inserts a drop cap into the Word document

  • addEndnote

    Inserts an endnote into the Word document

  • addExternalFile

    Adds an external DOCX, HTML, MHT, RTF or TXT file

  • addFootnote

    Inserts a footnote into the Word document

  • addFormElement

    Inserts form elements into the Word document

  • addHeading

    Inserts a heading into the Word document

  • addImage

    Inserts an image into the Word document

  • addLink

    Inserts a link into the Word document

  • addList

    Inserts (nested) lists into the Word document

  • addMathEquation

    Inserts a math equation in OMML or MathML format

  • addMergeField

    Adds a merge field to the Word document

  • addPageNumber

    Inserts the current page number into the Word document

  • addRuby

    Adds a ruby (phonetic guide) content into the Word document

  • addSimpleField

    Adds a simple field to the Word document

  • addStructuredDocumentTag

    Inserts different types of Structured Document Tags into the Word document

  • addSVG

    Inserts an SVG into the Word document

  • addTab

    Inserts a tab into a Word document

  • addTable

    Inserts a table into a Word document

  • addTableContents

    Inserts a Table of Contents (TOC) into the Word document

  • addTableFigures

    Inserts a Table of Figures into the Word document

  • addText

    Inserts a paragraph into the Word document

  • addTextBox

    Inserts a Text Box in the Word document

  • addWordFragment

    Inserts a WordFragment into the Word document

  • addWordML

    Inserts raw WordML code into the Word document

  • embedHTML

    Inserts HTML content into the Word document

Layouts
Templates
Format conversion
DOCXPath
DOCXUtilities
PDFUtilities
DOCXCustomizer
Performance
  • chunkMode

    Improves performance and reduces memory usage when adding tables and lists

  • zipStream

    Generates a DOCX stream without saving the document to the file system