ExportConfig>= v1.12.0

ExportConfig:

type ExportConfig =
  | ExportPDFConfig
  | ExportDOCXConfig
  | ExportMarkdownConfig
  | ExportRTFConfig
  | ExportODTConfig;

Export configuration specifying the target format and any format-specific options.

See

DocAuthDocument.export

Variants

ExportPDFConfig

Export as PDF.

Property	Type	Description
format	"pdf"	(required)
updateFields	boolean	Update every field before exporting, as DocAuthDocument.updateFields does, so
the export shows up-to-date tables of contents, page references and page counts. The
fields are updated in a copy: the document itself is not changed. Default: false
PDF_A	boolean	Generate a PDF/A compliant PDF. Default: false
bookmarks	`“headings"	"documentBookmarks"
”Create bookmarks using” option does:

• 'headings': the paragraphs styled Heading 1 to Heading 6, titled by their text and nested by level. Paragraphs in other styles are not listed, even when the style has an outline level.
• 'documentBookmarks': the bookmarks in the document, by name, in reading order. Hidden bookmarks such as _Toc… are left out.
• 'none': no PDF bookmarks.

Only the main text contributes: headings and bookmarks in headers, footers, notes and text boxes are not listed. Default: 'headings' | | abortSignal | AbortSignal | An optional signal to abort the export operation. |

ExportDOCXConfig

Export as DOCX.

Property	Type	Description
format	"docx"	(required)
updateFields	boolean	Update every field before exporting, as DocAuthDocument.updateFields does, so
the export shows up-to-date tables of contents, page references and page counts. The
fields are updated in a copy: the document itself is not changed. Default: false
abortSignal	AbortSignal	An optional signal to abort the export operation.

ExportMarkdownConfig

Export as Markdown.

Property	Type	Description
format	"markdown"	(required)
updateFields	boolean	Update every field before exporting, as DocAuthDocument.updateFields does, so
the export shows up-to-date tables of contents, page references and page counts. The
fields are updated in a copy: the document itself is not changed. Default: false
abortSignal	AbortSignal	An optional signal to abort the export operation.

ExportRTFConfig

Export as RTF.

Property	Type	Description
format	"rtf"	(required)
updateFields	boolean	Update every field before exporting, as DocAuthDocument.updateFields does, so
the export shows up-to-date tables of contents, page references and page counts. The
fields are updated in a copy: the document itself is not changed. Default: false
abortSignal	AbortSignal	An optional signal to abort the export operation.

ExportODTConfig

Export as ODT.

Property	Type	Description
format	"odt"	(required)
updateFields	boolean	Update every field before exporting, as DocAuthDocument.updateFields does, so
the export shows up-to-date tables of contents, page references and page counts. The
fields are updated in a copy: the document itself is not changed. Default: false
abortSignal	AbortSignal	An optional signal to abort the export operation.