Reporting for Angular

• May 24, 2021
• 2 minutes to read

Topics in this section describe how to create reporting applications based on the Angular framework.

View Example: ASP.NET Core Reporting - Best Practices (ASP.Net Core application with an Angular frontend)

DevExpress Web Reporting controls are composed of DevExtreme UI components. Angular versions supported by the DevExtreme Component Suite are listed in the following help topic: Supported Versions.

Document Viewer

Quick Start

• Create an Angular Application with a Document Viewer From Template
• Create an Angular Front-End Application with a Document Viewer
• Document Viewer Client-Side Configuration in Angular Application

Customization

• Customize the Document Viewer Toolbar in Angular Application
• Customize the Document Viewer Tab Panel in Angular Application
• Pass Parameters from the Client to a Report in Angular Application

Report Designer

Quick Start

• Create an Angular Application with a Report Designer From Template
• Create an Angular Front-End Application with a Report Designer
• Report Designer Client-Side Configuration in Angular Application

Print and Export

• Print and Export in Angular Application
• Print and Export without a Preview in Angular Application

Localization

• Localization in Reporting for Angular

Client-Side API

To access the client-side Reporting API in Angular applications, use the following objects:

• Document Viewer - the JSReportViewer class
• Report Designer - the JSReportDesigner class

Client-side events in Angular are handled with callbacks specified in the Knockout bindings.

Event names and data in event arguments passed to the Angular callback handler functions are the same as events in an ASP.NET Core application. Review the following help topics with information on ASP.NET Core client-side events:

• WebDocumentViewerClientSideEventsBuilder
• ReportDesignerClientSideEventsBuilder

For more information on Knockout bindings, review the following help topics:

• Document Viewer Client-Side Configuration (Knockout Bindings)
• Report Designer Client-Side Configuration (Knockout Bindings)

The following code snippet illustrates how to use the CustomizeExportOptions callback to remove the XLS format from the Export To drop-down list and from the Export Options panel:

Angular

 

report-viewer.html

<div>
    <dx-report-viewer [reportUrl]="reportUrl" height="800px">
        <dxrv-request-options [invokeAction]="invokeAction" [host]="hostUrl">
        </dxrv-request-options>
        <dxrv-callbacks (CustomizeExportOptions)="OnCustomizeExportOptions($event)">
        </dxrv-callbacks>
    </dx-report-viewer>
</div>

 

report-viewer.ts

import { ExportFormatID } from 'devexpress-reporting/dx-webdocumentviewer'
import { Component, Inject, ViewEncapsulation, ViewChild } from '@angular/core';
import { DxReportViewerComponent } from 'devexpress-reporting-angular';


@Component({
// ...
})
export class ReportViewerComponent {
    @ViewChild(DxReportViewerComponent, { static: false }) viewer: DxReportViewerComponent;
    reportUrl: string = "TestReport";
    invokeAction: string = '/DXXRDV';

    OnCustomizeExportOptions(event) {
        event.args.HideFormat(ExportFormatID.XLS);
    }

  constructor(@Inject('BASE_URL') public hostUrl: string) { }
}