Skip to content

editor › Globals › ExportResultSaver

Class: ExportResultSaver

utility for turning results from the Exporter into one downloadable file blob and naming all the subfolders and -files

Hierarchy

  • ExportResultSaver

Index

Properties

Methods

Properties

Private svgExportHadOversizedPlates

• svgExportHadOversizedPlates: boolean = false

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:30

Private Readonly timestamp

• timestamp: string = Config.get("svgExport.addTimestampToExportedFiles") ? dateFormat(" (yyyy-mm-dd HH_MM_ss)") : ""

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:31

Methods

Private _makeFileName

▸ _makeFileName(modelName: string): string

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:133

Parameters:

Name Type
modelName string

Returns: string

Private _makeZipIfNeeded

▸ _makeZipIfNeeded(files: File[], zipFileName: string): Promise‹File›

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:167

if files contains multiple files, turn them into a single zip file

Parameters:

Name Type
files File[]
zipFileName string

Returns: Promise‹File›

Private _saveFile

▸ _saveFile(exportFile: IExportFile, fileName: string): File

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:160

Parameters:

Name Type
exportFile IExportFile
fileName string

Returns: File

Private _saveFiles

▸ _saveFiles(exportFiles: Array‹IExportFile & object›, fileName: string, numberingString: string): File[]

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:143

turns an array of IExportFiles into savable files

Parameters:

Name Type Default Description
exportFiles Array‹IExportFile & object› - the files to be saved
fileName string - the base file name for the files
numberingString string "" the string to be appended along with an index if exportFiles contains more than 1 element

Returns: File[]

getSvgExportHadOversizedPlates

▸ getSvgExportHadOversizedPlates(): boolean

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:124

Returns: boolean

saveCutplanExport

▸ saveCutplanExport(modelName: string, exportResult: IExportFile): File

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:105

creates a ready-to-save blob file object from a cutplan export result

Parameters:

Name Type
modelName string
exportResult IExportFile

Returns: File

saveObjExport

▸ saveObjExport(modelName: string, exportResult: IExportFile): File

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:112

creates a ready-to-save blob file object an obj export result

Parameters:

Name Type
modelName string
exportResult IExportFile

Returns: File

saveStlExport

▸ saveStlExport(modelName: string, exportResult: IExportFile[]): Promise‹File›

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:119

creates a ready-to-save file object from stl export results

Parameters:

Name Type
modelName string
exportResult IExportFile[]

Returns: Promise‹File›

saveSvgExport

▸ saveSvgExport(modelName: string, __namedParameters: object, primaryOutlineOffset?: number, testStrip?: IExportFile, foamcoreTestStrip?: IExportFile, helpImage?: IExportFile, exportSessionId?: string): Promise‹File›

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:38

creates a ready-to-save file object from svg export results

Parameters:

▪ modelName: string

▪ __namedParameters: object

Name Type
booklet IExportFile[]
svgExports object[]

▪Optional primaryOutlineOffset: number

▪Optional testStrip: IExportFile

▪Optional foamcoreTestStrip: IExportFile

▪Optional helpImage: IExportFile

▪Optional exportSessionId: string

Returns: Promise‹File›

saveTestStrip

▸ saveTestStrip(testStrip: IExportFile): File

Defined in src/modules/kyub.core.svgObjExporter/src/ExportResultSaver.ts:128

Parameters:

Name Type
testStrip IExportFile

Returns: File