Member Junction
    Preparing search index...

    Class ExportEngine

    Main export engine class Provides a unified API for all export formats including multi-sheet Excel workbooks

    Index

    Constructors

    constructor

    Methods

    createExporter CreateExporter CreateExporterAsync export Export getFileExtension GetFileExtension getFormatCapabilities GetFormatCapabilities getMimeType GetMimeType getSupportedFormats GetSupportedFormats supportsFormulas SupportsFormulas supportsMultiSheet SupportsMultiSheet supportsStyling SupportsStyling toCSV ToCSV toExcel ToExcel toExcelMultiSheet ToExcelMultiSheet toJSON

    Constructors

    Methods

    • Parameters

      Returns {
          conditionalFormatting: boolean;
          dataValidation: boolean;
          formulas: boolean;
          images: boolean;
          multiSheet: boolean;
          protection: boolean;
          styling: boolean;
      }

      Use GetFormatCapabilities.

    • Get format capabilities

      Parameters

      Returns {
          conditionalFormatting: boolean;
          dataValidation: boolean;
          formulas: boolean;
          images: boolean;
          multiSheet: boolean;
          protection: boolean;
          styling: boolean;
      }

    • Parameters

      • sheets: SheetDefinition[]
      • options: {
            calcOnSave?: boolean;
            defaultDateFormat?: string;
            defaultNumberFormat?: string;
            fileName?: string;
            metadata?: WorkbookMetadata;
        } = {}

      Returns Promise<ExportResult>

      Use ToExcelMultiSheet.

    • Create a multi-sheet Excel workbook

      Parameters

      • sheets: SheetDefinition[]

        Array of sheet definitions

      • options: {
            calcOnSave?: boolean;
            defaultDateFormat?: string;
            defaultNumberFormat?: string;
            fileName?: string;
            metadata?: WorkbookMetadata;
        } = {}

        Additional workbook options

      Returns Promise<ExportResult>

      Export result with buffer and metadata

      const result = await ExportEngine.toExcelMultiSheet([
        {
          name: 'Sales Data',
          data: salesData,
          headerStyle: { font: { bold: true }, fill: { pattern: 'solid', fgColor: '4472C4' } }
        },
        {
          name: 'Summary',
          data: summaryData,
          formulas: [{ cell: 'B10', formula: 'SUM(B2:B9)' }]
        }
      ], {
        fileName: 'quarterly-report',
        metadata: { author: 'Sales Team', title: 'Q1 2024 Report' }
      });

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods