Report

TypeScript
export interface Report extends QueryObject
Extends

QueryObject

Properties

PropertyDescription
CustomReportFunctionName of User Function to be invoked when running a Custom Report
NameName of Report - mandatory property
ReportColumnScopeColumns to display in Report
ReportRowScopeRows to export when Report runs
ScopeColumns Scope; only required if ReportColumnScope is 'ScopeColumns'

Property Details

CustomReportFunction

Name of User Function to be invoked when running a Custom Report

TypeScript
CustomReportFunction?: string;
Property Value

string

Name

Name of Report - mandatory property

TypeScript
Name: SystemReportName | string;
Property Value

SystemReportName | string

ReportColumnScope

Columns to display in Report

TypeScript
ReportColumnScope: 'AllColumns' | 'VisibleColumns' | 'SelectedColumns' | 'ScopeColumns' | 'CustomColumns';
Property Value

'AllColumns' | 'VisibleColumns' | 'SelectedColumns' | 'ScopeColumns' | 'CustomColumns'

ReportRowScope

Rows to export when Report runs

TypeScript
ReportRowScope: 'AllRows' | 'VisibleRows' | 'SelectedCellRows' | 'SelectedRows' | 'ExpressionRows' | 'CustomRows';
Property Value

'AllRows' | 'VisibleRows' | 'SelectedCellRows' | 'SelectedRows' | 'ExpressionRows' | 'CustomRows'

Scope

Columns Scope; only required if ReportColumnScope is 'ScopeColumns'

TypeScript
Scope?: AdaptableScope;
Property Value

AdaptableScope