AdapTable Version:

Framework:

Custom Reports

Summary

AdapTable allows users to create Custom Reports
These can be configured by developers at design-time, or build in the UI at run-time
Custom Reports typically use an Expression
Custom Reports can be exported in various formats to all destinations

Custom (i.e. bespoke) Reports can be provided to supplement the System Reports shipped by AdapTable.

Custom Reports can be created and supplied in 2 ways:

by run-time users via the Export Wizard
at design-time through Export Initial State

AdapTable enables these reports to be exported to all available destinations.

Each Custom Report specifies which columns and rows to export.

Note

Custom Report rows typically contain a Boolean Expression, evaluated by AdapTableQL each time the Report runs

Custom Reports

Fork Fork

This demo contains 2 Custom Reports (provided in Export Initial State):
- Popular Frameworks - exports 2 columns for rows with Github Stars > 50000
- MIT JavaScript - exports 5 columns for rows where Language is JavaScript and the License is MIT License

Defining Custom Reports

Custom Reports can be provided at design-time in Export Initial State.

Developer Guide

Defining a Custom Report

Follow these steps to define a Custom Report:

const initialState: InitialState = {
    Export: {
       Reports: [
        {
            ReportColumnScope: 'ScopeColumns',
            ReportRowScope: 'ExpressionRows',
            Scope: {ColumnIds: ['name', 'language']},
            Query: {BooleanExpression: '[github_stars]>50000'},
            Name: 'Popular Frameworks',
        },
    ],
  },
}

Set Report Column Scope

ReportColumnScope defines the Report's columns.

The available values are:

AllColumns - every Column defined in AG Grid GridOptions
VisibleColumns - every visible Column in the Grid
ScopeColumns - bespoke Column list (defined separately)

const initialState: InitialState = {
    Export: {
       Reports: [
        {
            ReportColumnScope: 'ScopeColumns',
            ReportRowScope: 'ExpressionRows',
            Scope: {ColumnIds: ['name', 'language']},
            Query: {BooleanExpression: '[github_stars]>50000'},
            Name: 'Popular Frameworks',
        },
    ],
  },
}

Provide Scoped Columns (if required)

If ReportColumnScope is set to ScopeColumns, then these must be listed separately in the Scope property.

This defines which Columns, Column Types or Data Types will be exported.

Find Out More

See Scope for a detailed look at this commonly used object

const initialState: InitialState = {
    Export: {
       Reports: [
        {
            ReportColumnScope: 'ScopeColumns',
            ReportRowScope: 'ExpressionRows',
            Scope: {ColumnIds: ['name', 'language']},
            Query: {BooleanExpression: '[github_stars]>50000'},
            Name: 'Popular Frameworks',
        },
    ],
  },
}

Set Report Row Scope

ReportRowScope defines the Report's rows.

The available values are:

AllRows - every Row in AG Grid's data source
VisibleRows - Rows currently in Grid (if not viewport)
ExpressionRows - Rows returned by AdapTableQL Query (see below)

const initialState: InitialState = {
    Export: {
       Reports: [
        {
            ReportColumnScope: 'ScopeColumns',
            ReportRowScope: 'ExpressionRows',
            Scope: {ColumnIds: ['name', 'language']},
            Query: {BooleanExpression: '[github_stars]>50000'},
            Name: 'Popular Frameworks',
        },
    ],
  },
}

Provide a Query (if required)

If ReportRowScope is set to ExpressionRows, then the Query property must also be provided.

This contains the Expression which will be evaluated by AdapTableQL each time the Report is run.

Hint

Rows exported via a query do not need to be visible in the Grid when the Report runs, but do need to be in the underlying Data Set

const initialState: InitialState = {
    Export: {
       Reports: [
        {
            ReportColumnScope: 'ScopeColumns',
            ReportRowScope: 'ExpressionRows',
            Scope: {ColumnIds: ['name', 'language']},
            Query: {BooleanExpression: '[github_stars]>50000'},
            Name: 'Popular Frameworks',
        },
    ],
  },
}

Give the Report a Name

Provide a unique, and easily identifiable name for the Report via the Name property.

This value will be used wherever the Report is referenced, e.g. in the Toolbar, Tool Panel or Export section of the Settings Panel.

Custom Reports

Summary

Note

Defining Custom Reports

Developer Guide

Defining a Custom Report

Find Out More

Hint

Using Custom Report Wizard

UI Step by Step Guide

Using the Export Wizard to Create / Edit Custom Reports

Find Out More

Caution

Find Out More