Report Destinations

Summary

AdapTable provides 2 System Export Destinations for Reports: Download and Clipboard
Developers can configure which are available - including on a per Report basis

The Report Export Destination determines where a Report is sent.

System Export Destinations

AdapTable ships with 2 Export Destinations

Download - available for all Report Formats
Clipboard - available only for CSV and JSON Report Formats

Note

The Export button displays a dropdown showing all available Destinations for current Report and Report Format
However, if the Report can only have a single Destination, the Export button becomes a regular button

Limiting System Destinations

By default both System Export Destinations are available to users.

Where this is not required behaviour, use the systemExportDestinations property in Export Options.

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

systemExportDestinations

Default: Download & Clipboard

SystemExportDestinations[]

Sets which Export Destinations provided by AdapTable are available for Reports

SystemExportDestinations[]

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

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

Hard Coded List

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

// Make only the 'Download' System Export Destination available (hiding the Clipboard)
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
        systemExportDestinations: ['Download'],
    }
}

Hint

Provide an empty array if you want none to be available:

// Show No System Export Destinations
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
        systemExportDestinations: [],
    }
}

Via a Function

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

The function receives context of type SystemExportDestinationsContext defined as follows:

Property	Description
currentLayoutName	Name of current Layout
currentReportFormat	Format of current Report
currentReportName	Name of current Report
defaultSystemExportDestinations	Default System Export Destinations
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

// Only Export to Download for the 'All Data' report
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
      systemExportDestinations: (context: SystemExportDestinationsContext) => {
        return context.currentReportName == 'All Data'
          ? ['Download']
          : context.defaultSystemExportDestinations;
      },
    }
}

Configuring System Export Destinations

Fork Fork

In this example AdapTable has been limited to just the Clipboard System Export Destination

Custom Export Destinations

If the System Export Destinations provided by AdapTable are insufficient, developers can easily supply their own custom export destinations.

Find Out More

See the Guide to creating Custom Export Destinations for more information

PreviousJSON NextCustom Destinations