Skip to main content
Elements of the paragraphs array are objects describing paragraphs of text. When a paragraph is detected, its function on that page is specified. Additionally, information about the formatting of text in that region and about whether the paragraph belongs to a list is also recorded.
PropertyData typeDescription
idstringThe identifier of the paragraph in a document.
rolestring enumThe function of the paragraph in the document. Possible values: other, text, heading, headingNumber, tableOfContents, tableText, runningTitle, endNote, footNote, tableCaption, tableHeading, pictureCaption, artefact
formattingobjectThe paragraph formatting.
layoutReferencesobject arrayAn array of objects that determine the mapping between parts of the paragraph and text blocks on a page, as well as specifying the location of the paragraph in the document’s logic structure.
textstringThe paragraph text.
listReferenceobjectIf the paragraph belongs to a list, this object specifies the level of the list to which the paragraph belongs, as well as the location of the paragraph in that list.