AdapTable Reports

Summary

AdapTable provides 3 System Reports which can be run at any time
Thes are designed to cover the most common use cases: All Data, Current Layout and Selected Data
System Reports can be exported in various formats to all destinations

AdapTable ships with 3 System (i.e. predefined) Reports designed for frequently used exports:

Report	Contains	Cols & Rows
`All Data`	All Data in Grid's Dataset (i.e. all Rows and Columns)	All
`Current Layout`	Data in current Layout (i.e. currently filtered Rows and visible Columns)	Visible
`Selected Data`	Currently selected Grid data (both Cells and Rows)	Selected

Note

Additionally developers and run-time users can create bespoke Custom Reports

Exporting System Reports

Fork Fork

In this example AdapTable has been set up so that:
- the Current Report is the All Data System Report
- the Report Format is JSON

Try It Out

Click the Export button in the Export toolbar and select 'Download' to send the report as a JSON file

Limiting System Reports

By default all 3 System Reports will be shipped with AdapTable and available for use.

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

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

systemReportNames

Default: All 3 System Reports

SystemReportNames[]

Sets which System Reports are available for users

SystemReportNames[]

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

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

Hard Coded List

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

// Show just 'All Data' and 'Current Layout' System Reports
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
        systemReportNames: ['All Data', 'Current Layout'],
    }
}

Hint

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

// Show No System Reports
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
        systemReportNames: [],
    }
}

Via a Function

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

The function receives context of type SystemReportNamesContext defined as follows:

Property	Description
currentLayoutName	Name of current Layout
defaultSystemReportNames	Default System Report Names
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

// Show just 'All Data' System Report when in 'Pivot View' Layout
const adaptableOptions: AdaptableOptions = {
    exportOptions: {
      systemReportNames: (context: SystemReportNamesContext) => {
        return context.currentLayoutName == 'Pivot View'
          ? ['All Data']
          : context.defaultSystemReportNames;
      },
    }
}

Developers can supply a list of System Report names to this property and only these reports will be available.

Note

If the Selected Data report is removed from System Reports using the function above, the Export Selected Cells and Export Selected Rows Menu Items in the Context Menu will still remain
Use the properties available in Context Menu Options to remove these menu items completely

Configuring System Reports

Fork Fork

In this example AdapTable has been limited to just 2 System Reports:
- All Data
- Current Layout

PreviousExporting NextCustom Reports