Exporting Data from AdapTable

Exporting in AdapTable enables data in AG Grid to be sent (in the form of Reports) to other locations.

Exporting a Report is a straightforward, 3-step process, comprising 3 elements:

1. A Report - a defined set of rows and columns (provided by AdapTable or created by users)
2. A Report Format Type - one of Excel, VisualExcel, JSON or CSV
3. An Export Destination (either provided by AdapTable or by users)

import {ReportContext} from '@adaptabletools/adaptable';
import {AdaptableOptions} from '@adaptabletools/adaptable';
import {WebFramework} from './rowData';

export const adaptableOptions: AdaptableOptions<WebFramework> = {
  primaryKey: 'id',
  adaptableId: 'Export Demo',
  exportOptions: {
    appendFileTimestamp: true,
    exportDateFormat: 'yyyy-dd-MM',
    exportDataFormat: 'formattedValue',
    customDestinations: [
      {
        name: 'REST Endpoint',
        onExport: (reportContext: ReportContext) => {
          console.log('Sending to REST: Report: "' + reportContext.report.Name);
          console.log('Report data:', reportContext.reportData);
        },
      },
    ],
  },

  initialState: {
    Dashboard: {
      Tabs: [
        {
          Name: 'Demo',
          Toolbars: ['Export'],
        },
      ],
    },
    StatusBar: {
      StatusBars: [
        {
          Key: 'Center Panel',
          StatusBarPanels: ['Export'],
        },
      ],
    },
    Theme: {CurrentTheme: 'dark'},

    Export: {
      CurrentReport: 'Popular Frameworks',
      CurrentFormat: 'JSON',
      Reports: [
        {
          Name: 'Popular Frameworks',
          ReportColumnScope: 'ScopeColumns',
          ReportRowScope: 'ExpressionRows',
          Scope: {ColumnIds: ['name', 'language']},
          Query: {BooleanExpression: '[github_stars] > 50000 '},
        },
      ],
    },
    FormatColumn: {
      FormatColumns: [
        {
          Name: 'formatColumn-created_at',
          Scope: {ColumnIds: ['created_at']},
          DisplayFormat: {
            Formatter: 'DateFormatter',
            Options: {
              Pattern: 'yyyyMMdd',
            },
          },
        },
      ],
    },
    Layout: {
      CurrentLayout: 'Standard Layout',
      Layouts: [
        {
          TableColumns: [
            'name',
            'language',
            'github_stars',
            'license',
            'has_projects',
            'has_pages',
            'created_at',
            'has_wiki',
            'updated_at',
            'pushed_at',
            'github_watchers',
            'week_issue_change',
          ],
          Name: 'Standard Layout',
          AutoSizeColumns: true,
        },
      ],
    },
  },
};

Reports

There are 2 types of Reports available in AdapTable:

• System Reports - shipped by AdapTable and used in most common use cases
• Custom Reports - provided by users (in UI or in InitialState) specifying which Columns and Rows to export

Report Format Types

AdapTable enables Reports to be created in 4 different Report Format Types

• Excel

• Visual Excel (includes styling)

• CSV

• JSON

Export Destinations

By default exported Reports are available in 2 System Export Destinations which are shipped by AdapTable:

• as a downloadable File which the user can download and run as required

• sent to the Clipboard (for CSV and JSON Report Format Types only)

It is also possible to export Reports to Custom Destinations that are supplied by developers at design-time using the customDestinations property in Export Options.

Customising Reports

AdapTable provides many Export Options to configure the behaviour or appearance of Reports.

These options include (among others):

• configuring which Reports, Report Format Types or Destinations are available to the user in the UI
• setting the name of the downloaded file
• customizing the exported data e.g. to export formatted data or bespoke formats for Date columns
• processing the report - to run it on the server, or to cancel the export
• choosing whether to include Column Headers in the exported data
• configuring which Columns can be fully excluded from Export

Using Export

Reports are managed at runtime via the Export section of the Settings Panel.

This lists the details of all Reports, and associated Report Format Types, in Adaptable State with options to:

• Run with a dropdown showing all available destinations
• Create (Custom Reports only - via the Export Wizard)
• Edit (Custom Reports only - via the Export Wizard)
• Delete
• Suspend
• Share (if Team Sharing is running)
• Schedule (so they run at a specified time)

Running Reports

Reports can be run from a number of places:

• Export Toolbar in the Dashboard
• Export Tool Panel in the AdapTable ToolPanel Component
• Export Status Bar Panel in the AdapTable Status Bar
• Export Section in the Settings Panel
• Via the Context Menu (Selected Data Report only)
• Programmatically via methods in the Export API section of AdapTable API

FAQ

Is the export 'live' - will it update when the grid data changes? No - export is a one time only snapshot. However AdapTable contains Modules (all available as Plugins) which do offer Live Data e.g. ipushpull and OpenFin

Do you include column names in the exported data? Yes, column names are always included in the Report

Is there an option when just copying to the clipboard to exclude column names? Yes, using the skipColumnHeaders property in Export Options

Is there a limit on the number of reports that I can create? No, reports like all other Adaptable Objects are unlimited.

Is there a limit on how much data I can export? AdapTable doesn't set a limit as everyone's computer and hardware is different. It also depends which destination you are sending to. As a general rule if sending to Excel we advise not exporting more than 300,000 cells.

Deep Dive

Exporting huge data sets to Excel

Learn More

Because exporting takes place in the browser, there is a memory limit on how much data can be sent to Excel.

If you want to send a lot of raw data to Excel there are are few options:

• export the data instead as csv as that has a much lower memory footprint
• create a Custom Export Destination which will allow you to open / create the Excel file on your client
• run the getReportDataForReport function in Export API and then send it to Excel locally

Why can I not see the Excel Report Format Type? Make sure you are have the correct AG Grid Modules set (i.e. ExcelExportModule) for this option to be available.

Can I run a Report even though it will display data not in AdapTable? Yes, you can process the Report each time it runs and leverage that to provide any data you require.

Can I hide some of the shipped Reports or Format Types? Yes, both are available via systemReportNames and systemReportFormats properties in Export Options respectively

Can I export the display formatted cell value in the column and not the raw value? Yes by setting the exportDataFormat property in Export Options.