Overview
Below is the list of all options available during initialization for the Native Angular Report Viewer.
How to configure the options
The options can be set from the .HTML
/.TS
component file or both(combined):
<reporting-angular-viewer
#viewer
[reportSource]="reportSource"
[serviceUrl]="serviceUrl"
viewMode="interactive"
[keepClientAlive]="true">
</reporting-angular-viewer>
import { Component, ViewChild } from '@angular/core';
import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer'
import { ReportSourceOptions } from '@progress/telerik-common-report-viewer'
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
})
export class AppComponent {
title = 'Native Angular Report Viewer Demo';
@ViewChild('viewer') public viewer!: ReportingAngularViewerComponent;
reportSource: ReportSourceOptions = { report: "Dashboard.trdx", parameters: { ReportYear: 2004 } };
serviceUrl: string = "https://demos.telerik.com/reporting/api/reports";
}
Options
Property | Description |
---|---|
serviceType |
string, required; Specifies the type of service that the report viewer will connect to. Available options are:
|
serviceUrl |
string, required if Sets the address of the Reporting REST Service; |
reportSource |
ReportSourceOptions, required; Specifies the report and initial report parameter values to be displayed in the report viewer. The ReportSourceOptions object is made up of the following properties:
To set the reportSource to a physical (TRDP/TRDX/TRBP) file, provide a relative path to the Report property of the ReportSourceOptions object.
To set the ReportSource to a type definition:
|
scaleMode |
string, optional; Sets how the report pages to be scaled. Available options are:
|
scale |
double, optional; Sets the scale factor for the report pages. The scale takes effect when the ScaleMode is set to Specific. Default value is 1.0 (100%); the original size of the report |
viewMode |
Sets if the report is displayed in interactive mode or in print preview. The available values are:
|
pageMode |
Sets if the report is displayed in Single page or Continuous scroll mode. The available values are:
|
printMode |
Specifies how the viewer should print reports. The available values are:
|
parametersAreaVisible |
boolean, optional; Determines whether the viewer's parameters area is displayed if any parameter editor exists. Default value: true |
documentMapVisible |
boolean, optional; Determines whether the viewer's document map is displayed if any bookmark is defined. Default value: true |
keepClientAlive |
boolean, optional; Determines whether the client will be kept alive. When set to true, expiration of the client will be prevented by continually sending a request to the server, determined by the Reporting REST service's ClientSessionTimeout. Default value: false |
width |
string, optional; The width of the component. Default value: 100% |
height |
string, optional; The height of the component. Default value: 700px |
contentTabIndex |
number, optional; Controls what value will be set on the tabindex attribute of the Default value is 1000. |
authenticationToken |
string, optional; If provided, a |