diff --git a/embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/api-reference/events.md b/embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/api-reference/events.md index 6e8f8be50..e35967d3d 100644 --- a/embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/api-reference/events.md +++ b/embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/api-reference/events.md @@ -77,12 +77,13 @@ The `printStarted` event will be emitted when the printing starts. [serviceUrl]="'https://demos.telerik.com/reporting/api/reports'" viewMode="interactive" [keepClientAlive]="true" - (printStarted)="printStarted()"> + (printStarted)="printStarted($event)"> ```` ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { PrintStartedEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -95,8 +96,8 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - printStarted() { - console.log("This event will be emitted when the printing starts."); + printStarted(printStartedEventArgs: PrintStartedEventArgs) { + console.log("This event will be emitted when the printing starts.", printStartedEventArgs); }; } ```` @@ -116,12 +117,13 @@ The `printDocumentReady` event will be emitted after the viewer finishes printin [serviceUrl]="'https://demos.telerik.com/reporting/api/reports'" viewMode="interactive" [keepClientAlive]="true" - (printDocumentReady)="printDocumentReady()"> + (printDocumentReady)="printDocumentReady($event)"> ```` ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { PrintDocumentReadyEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -134,8 +136,8 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - printDocumentReady() { - console.log("This event will be emitted after the viewer finishes printing the report."); + printDocumentReady(printDocumentReadyEventArgs: PrintDocumentReadyEventArgs) { + console.log("This event will be emitted after the viewer finishes printing the report.", printDocumentReadyEventArgs); }; } ```` @@ -155,12 +157,13 @@ The `exportStarted` event will be emitted when an export operation is triggered. [serviceUrl]="'https://demos.telerik.com/reporting/api/reports'" viewMode="interactive" [keepClientAlive]="true" - (exportStarted)="exportStarted()"> + (exportStarted)="exportStarted($event)"> ```` ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { ExportStartedEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -173,9 +176,9 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - exportStarted() { - console.log("This event will be emitted when an export operation is triggered."); - }; + exportStarted(exportStartedEventArgs: ExportStartedEventArgs) { + console.log("This event will be emitted when an export operation is triggered.", exportStartedEventArgs); + }; } ```` @@ -194,12 +197,13 @@ The `exportDocumentReady` event will be emitted after the viewer finishes export [serviceUrl]="'https://demos.telerik.com/reporting/api/reports'" viewMode="interactive" [keepClientAlive]="true" - (exportDocumentReady)="exportDocumentReady()"> + (exportDocumentReady)="exportDocumentReady($event)"> ```` ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { ExportDocumentReadyEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -212,9 +216,9 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - exportDocumentReady() { - console.log("This event will be emitted after the viewer finishes exporting the report."); - }; + exportDocumentReady(exportDocumentReadyEventArgs: ExportDocumentReadyEventArgs) { + console.log("This event will be emitted after the viewer finishes exporting the report.", exportDocumentReadyEventArgs); + }; } ```` @@ -597,6 +601,48 @@ The `currentPageChanged` event will be emitted when the viewer changes its curre ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { CurrentPageChangedEventArgs } 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; + + currentPageChanged(currentPageChangedEventArgs: CurrentPageChangedEventArgs) { + console.log("The page number and document id.", currentPageChangedEventArgs); + console.log("This event will be emitted when the viewer changes its currently displayed page."); + }; + } +```` + + +### interactiveActionEnter + +The `interactiveActionEnter` event will be emitted when the cursor hovers over an interactive action. + +````HTML + + +```` +````TypeScript +import { Component, ViewChild } from '@angular/core'; +import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { PageActionEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -609,9 +655,9 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - currentPageChanged(e: { page number, reportDocumentId: string }) { - console.log("The page number and document id", e) - console.log("This event will be emitted when the viewer changes its currently displayed page."); + interactiveActionEnter(interactiveActionArgs: PageActionEventArgs) { + console.log("The interactive action arguments.", interactiveActionArgs); + console.log("This event will be emitted when the cursor hovers over an interactive action."); }; } ```` @@ -631,12 +677,135 @@ The `interactiveActionExecuting` event will be emitted before an interactive act [serviceUrl]="'https://demos.telerik.com/reporting/api/reports'" viewMode="interactive" [keepClientAlive]="true" - (interactiveActionExecuting)="interactiveActionExecuting()"> + (interactiveActionExecuting)="interactiveActionExecuting($event)"> + +```` +````TypeScript +import { Component, ViewChild } from '@angular/core'; +import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { PageActionEventArgs } 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; + + interactiveActionExecuting(pageActionEventArgs: PageActionEventArgs) { + console.log("This event will be emitted before an interactive action is executed.", pageActionEventArgs); + }; + } +```` + + +### interactiveActionLeave + +The `interactiveActionLeave` event will be emitted when the cursor leaves the interactive action area. + +````HTML + + +```` +````TypeScript +import { Component, ViewChild } from '@angular/core'; +import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { PageActionEventArgs } 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; + + interactiveActionLeave(interactiveActionArgs: PageActionEventArgs) { + console.log("The interactive action arguments.", interactiveActionArgs); + console.log("This event will be emitted when the cursor leaves the interactive action area."); + }; + } +```` + + +### toolTipOpening + +The `toolTipOpening` event will be emitted when a tooltip is opened. + +````HTML + + +```` +````TypeScript +import { Component, ViewChild } from '@angular/core'; +import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { TooltipEventArgs } 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; + + toolTipOpening(tooltipEventArgs: TooltipEventArgs) { + console.log("The tooltip arguments.", tooltipEventArgs); + console.log("This event will be emitted when a tooltip is opened."); + }; + } +```` + + +### toolTipClosing + +The `toolTipClosing` event will be emitted when a tooltip is closed. + +````HTML + ```` ````TypeScript import { Component, ViewChild } from '@angular/core'; import { ReportingAngularViewerComponent } from '@progress/telerik-angular-native-report-viewer' +import { TooltipEventArgs } from '@progress/telerik-common-report-viewer' @Component({ selector: 'app-root', @@ -649,8 +818,9 @@ import { ReportingAngularViewerComponent } from '@progress/telerik-angular-nativ @ViewChild('viewer') public viewer!: ReportingAngularViewerComponent; - interactiveActionExecuting() { - console.log("This event will be emitted before an interactive action is executed."); + toolTipClosing(tooltipEventArgs: TooltipEventArgs) { + console.log("The tooltip arguments.", tooltipEventArgs); + console.log("This event will be emitted when a tooltip is closed."); }; } ````