IExportOptions

23 Sep 20251 minute to read

Defines the options to export diagrams

Properties

bounds Rect

Sets the region that has to be exported

fileName string

Sets the file name of the exported image

format FileFormats

Sets the file format to save the file

  • JPG - Save the file in JPG Format
  • PNG - Saves the file in PNG Format
  • BMP - Save the file in BMP Format
  • SVG - save the file in SVG format

margin MarginModel

Sets the margin of the page to be printed

mode ExportModes

Sets the Mode for the file to be downloaded

  • Download - Downloads the diagram as image
  • Data - Sends the diagram as ImageUrl

multiplePage boolean

Defines whether the diagram has to be exported as single or multiple images

pageHeight number

Sets the height of the page to be printed

pageOrientation PageOrientation

Sets the orientation of the page to be printed

  • Landscape - Display with page Width is more than the page Height.
  • Portrait - Display with page Height is more than the page width.

pageWidth number

Sets the width of the page to be printed

printOptions boolean

Sets the printOptions that has to be printed

region DiagramRegions

Sets the region for the print settings

  • PageSettings - The region to be exported/printed will be based on the given page settings
  • Content - Only the content of the diagram control will be exported
  • CustomBounds - The region to be exported will be explicitly defined

stretch Stretch

Sets the aspect ratio of the exported image

  • None - Sets the stretch type for diagram as None
  • Stretch - Sets the stretch type for diagram as Stretch
  • Meet - Sets the stretch type for diagram as Meet
  • Slice - Sets the stretch type for diagram as Slice