PrincipalReportComponent

reference

3 min readUpdated 2026-08-11

Kind: Class

Source: Pams/Web/Pams.Web/Client/app/components/dashboard/_principalReport/principal-report.component.ts (line 97)

Part of: Pams

PrincipalReportComponent manages the principal dashboard report view. It handles introduction and outlines modal state, report period changes, date and numeral formatting, resize behavior, and page-number retrieval within the dashboard client.

Implements: OnInit

Methods

Method	Signature	Returns
`openIntroductionAndOutlinesPopup`	`openIntroductionAndOutlinesPopup()`	`void`
`closeIntroductionAndOutlinesModal`	`closeIntroductionAndOutlinesModal()`	`void`
`formatDate`	`formatDate(date: undefined)`	`void`
`NumeralConversionDefault`	`NumeralConversionDefault(num: number)`	`void`
`resizeWindow`	`resizeWindow()`	`void`
`ngOnInit`	`ngOnInit()`	`void`
`BookingHistoryPeriodChanged`	`BookingHistoryPeriodChanged(period: string)`	`void`
`DeliveriesHistoryPeriodChanged`	`DeliveriesHistoryPeriodChanged(period: string)`	`void`
`OverallAnalysisPeriodChanged`	`OverallAnalysisPeriodChanged(period: string)`	`void`
`getPageNumber`	`getPageNumber(pageId: string)`	`number`
`getAllLookups`	`getAllLookups()`	`void`
`AddInquiriesCol`	`AddInquiriesCol(e: undefined)`	`void`
`RemoveInquiriesCol`	`RemoveInquiriesCol(e: undefined)`	`void`
`AddOffersCol`	`AddOffersCol(e: undefined)`	`void`
`RemoveOffersCol`	`RemoveOffersCol(e: undefined)`	`void`
`getImagesFroPrint`	`getImagesFroPrint(accountId: number)`	`void`
`GenerateNewReport`	`GenerateNewReport()`	`void`
`GenerateReport`	`GenerateReport()`	`void`
`checkForCachedData`	`checkForCachedData()`	`void`
`prepareGeneratedReportParameter`	`prepareGeneratedReportParameter()`	`void`
`prepareGeneratedReportData`	`prepareGeneratedReportData()`	`void`
`compareReportSettings`	`compareReportSettings()`	`void`
`PrintReport`	`PrintReport()`	`void`
`scroll`	`scroll(id: undefined)`	`void`
`isScrolledIntoView`	`isScrolledIntoView(id: undefined)`	`void`
`checkScrolledIntoView`	`checkScrolledIntoView()`	`void`
`onAccountTypeChange`	`onAccountTypeChange(e: undefined)`	`void`
`onPrincipalChange`	`onPrincipalChange(e: undefined)`	`void`
`onPrincipalRemove`	`onPrincipalRemove(e: undefined)`	`void`
`onClientChange`	`onClientChange(e: undefined)`	`void`
`onClientRemove`	`onClientRemove(e: undefined)`	`void`
`onGridContentReady`	`onGridContentReady(e: undefined)`	`void`
`chooseWidget`	`chooseWidget(e: undefined)`	`void`
`onClientFilterChange`	`onClientFilterChange(e: undefined)`	`void`
`onProductTypeChange`	`onProductTypeChange(e: undefined)`	`void`
`onStatusChange`	`onStatusChange(e: undefined)`	`void`
`onSelectAllCharts`	`onSelectAllCharts()`	`void`
`ClosewithDonotSave`	`ClosewithDonotSave()`	`void`
`openTimeFrameOptions`	`openTimeFrameOptions()`	`void`
`openSettingsOptions`	`openSettingsOptions()`	`void`
`TimeFrameValueChanged`	`TimeFrameValueChanged()`	`void`
`OnOpenedPopup`	`OnOpenedPopup()`	`void`
`openPopup`	`openPopup(n: string, t: string, i: string, btnTxt: string)`	`void`
`savePopup`	`savePopup()`	`void`
`closePopup`	`closePopup()`	`void`
`ngDoCheck`	`ngDoCheck()`	`void`
`validate`	`validate(e: undefined)`	`void`
`selectText`	`selectText(e: undefined)`	`void`
`ngOnDestroy`	`ngOnDestroy()`	`void`
`onChartInit1`	`onChartInit1(e: any)`	`void`

Properties

Property	Type
`sharedPopup`	`SharedPopupComponent`
`GenerateReportValidation`	`DxValidationGroupComponent`
`TimeFrameValidation`	`DxValidationGroupComponent`
`alerts`	`AlertsComponent`
`RunningJobs`	`ElementRef`
`SalesOverview`	`ElementRef`
`FirmOffersElement`	`ElementRef`
`OrdersStatusElement`	`ElementRef`
`LostAnalysisElement`	`ElementRef`
`OrdersBookingElement`	`ElementRef`
`DeliveredOrdersElement`	`ElementRef`
`SubmittedOffersElement`	`ElementRef`
`OverallAnalysisElement`	`ElementRef`
`subscription`	`Subscription`
`LodingPanalMessage`	`any`
`loadingVisible`	`any`
`principals`	`any`
`clients`	`any`
`accountsInfo`	`PrincipalsInfo[]`
`selectedAccountInfo`	`number[]`
`SelectedAccount`	`string[]`
`SelectedPrincipalId`	`number`
`SelectedClientId`	`number`
`clientsFilters`	`any`
`accountType`	`any`
`productTypes`	`any`
`Status`	`any`
`SelectedStatuses`	`any`
`TempKey`	`string`
`Periods`	`any`
`DateDisplayFormat`	`any`
`dateDisplayFormatForTypeScript`	`any`
`DateDisplayFormatForMoment`	`any`
`UseDate`	`boolean`
`UsePeriod`	`boolean`
`ClientsPerChart`	`number`
`SelectAllCharts`	`boolean`
`ThisYear`	`any`
`TimeValue`	`number`
`TimePeriod`	`number`
`LostTotalAmount`	`number`
`LostTotalCount`	`number`
`SubmittedTotalCount`	`number`
`SubmittedTotalAmount`	`number`
`HitRateCount`	`number`
`HitRateValue`	`number`
`ReportData`	`any`
`ReportIsReady`	`boolean`
`GeneratedReport`	`boolean`
`dataBackdrop`	`string`

Where it refuses work

PrincipalReportComponent stops the work with an early return when date.
PrincipalReportComponent stops the work with an early return when dataField == "OfferTotalPrice" || dataField == "OrderTotalPrice" || dataField == "OrderBa….
PrincipalReportComponent stops the work with an early return when id == ReportSettingsEnum.ReportIntroduction.
PrincipalReportComponent stops the work with an early return when id == ReportSettingsEnum.ReportSalesAnalysis.
PrincipalReportComponent stops the work with an early return when id == ReportSettingsEnum.ReportLostOpportunities.
PrincipalReportComponent stops the work with an early return when id == ReportSettingsEnum.ReportClientComplaints.

Diagram

mermaid
graph LR
  Dashboard[Dashboard View] --> Report[PrincipalReportComponent]
  Report --> Modal[Introduction and Outlines Modal]
  Report --> Periods[Report Period Handlers]
  Report --> Formatting[Date and Numeral Formatting]
  Report --> Resize[Window Resize Handling]
  Report --> Page[Page Number]

Usage

ts
function manageReport(report: PrincipalReportComponent): number {
  report.openIntroductionAndOutlinesPopup();

  const pageNumber = report.getPageNumber();

  report.closeIntroductionAndOutlinesModal();

  return pageNumber;
}

AI Coding Instructions

Keep modal opening and closing behavior within openIntroductionAndOutlinesPopup() and closeIntroductionAndOutlinesModal().
Bind dashboard period controls to the relevant booking, deliveries, or overall-analysis period-change handler.
Preserve existing date and numeral formatting behavior by routing display values through formatDate() and NumeralConversionDefault().
Do not manually call ngOnInit() outside the Angular component lifecycle.
Keep resize-related UI updates inside resizeWindow() so window behavior remains centralized.

Used by

2 references from 2 files. Each is a place in this repository where the symbol is actually used — go read one rather than trusting an example.

Imported by (2)

AppRoutingModule — Pams/Web/Pams.Web/Client/app/app-routing.module.ts:1
TranslateHandler — Pams/Web/Pams.Web/Client/app/app.module.ts:1

Was this page helpful?

Download as PDF

ADocs generated by Atloria — from the code, always in sync →