Report Format Types

Summary

AdapTable ships with 4 Report Format Types that can be used to format Report data:
- Excel
- VisualExcel
- JSON
- CSV

Reports in AdapTable can be exported using 4 different Report Format Types:

Excel
VisualExcel
JSON
CSV

2 Format Types (JSON, CSV) export to File and Clipboard, and 2 (Excel, VisualExcel) just to File:

Report Format	All Reports	Exports to File	Exports to Clipboard
Excel	✅	✅	❌
Visual Excel	✅	✅	❌
`JSON`	✅	✅	✅
`CSV`	✅	✅	✅

Limiting System Report Formats

By default all System Report Format Types will be shipped with AdapTable and available for use.

However this can be changed via the systemReportFormats property of Export Options.

The property returns a list (either directly or via a function) of which System Report Formats should be available.

systemReportFormats

Default: All System Report Formats

SystemReportFormat[]

Sets which System Report Formats are available for users

SystemReportFormat[]

Use this property to specify a custom list of the System Report Formats which should be available to users.

You can return either an array of report formats, or provide a function which returns an array.

Hard Coded List

The simplest method is to return an array listing which System Report Formats should be available:

// Show just 'CSV' and 'JSON' System Report Formats
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
        systemReportFormats: ['CSV', 'JSON'],
    }
}

Hint

Provide an empty array if you want no System Report Formats to be available:

// Show No System Report Formats
const adaptableOptions: AdaptableOptions = {
  exportOptions: {
      systemReportFormats: [],
  }
}

Via a Function

Alternatively, you can provide a function which returns the System Report Formats.

The function receives context of type SystemReportFormatsContext defined as follows:

Property	Description
currentLayoutName	Name of current Layout
currentReportName	Name of current Report
defaultSystemReportFormats	Default System Report Formats
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

// Show just JSON and CSV Report Formats for 'All Data' System Report
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
      systemReportFormats: (context: SystemReportFormatsContext) => {
        return context.currentReportName == 'All Data'
          ? ['JSON', 'CSV']
          : context.defaultSystemReportFormats;
      },
    }
}

Configuring System Report Formats

Fork Fork

In this example AdapTable has been limited to just 2 System Report Formats:
- JSON
- CSV

FAQ

Can I export using a different Report Format Type to those provided by AdapTable e.g. PDF? At the moment its not possible to provide custom Report Format Types in the same way as Custom Reports but we hope to introduce that functionality soon. However you can provide PDF as a Custom Export Destination and then AdapTable will invoke the export function you provide, allowing you to use whichever PDF converter library you wish.

PreviousCustom Reports NextExcel