Options
All
  • Public
  • Public/Protected
  • All
Menu

Options and util provided for the exporter to as a complete foundation to create exported data Note: Do not need to include the systems because systems are already available in registree module> systems: ISystems;

collboard-modules-sdk

Hierarchy

  • Required<IExportFileOptions>
    • IFileExportSupporterOptions

Index

Properties

artContainers: IArtContainer[]

Arts to export

boardname: string

Name of the board

boundingBox: BoundingBox

Scope of the export

defaultFilename: string

Default filename Note: It can be overridden by returning File with different name

isHeavyExport: boolean

Should be heavy (=takes lot of resources) exports included?

default

false

isLinked: boolean

Link to the live board

deprecated

Probbably better and more clear name according to isNative

default

false

isMaterialized: boolean

Incorporate external sources into exported file

default

false

isNative: boolean

Add native data to the exported file

default

true

isTesting: boolean

Export should contain texting UI elements / testing metadata

default

false

isTransparent: boolean

Keep board background transparent

default

true

mimeType: ArrayableFull<string>

What mime types you are interested in

For example:

  • Specify exact types ['image/png', 'image/jpeg','application/pdf']
  • Specify wildcard types ['image/*']
  • Specify all types ['*']
quality: number

Quality of the exported image It should be between 0 and 1 (=100%)

Note: There are two distinct options influencing quality of export - quality and scale

default

0.92

scale: number

Enlarge the exported image against default zoom scale

Note: There are two distinct options influencing quality of export - quality and scale

default

1

Scope of the export

Note: Usually you do not need to use this because artContainers are already filtered by this scope