@esfaenza/dashboard-feature 15.2.11 → 15.2.13

package/fesm2020/esfaenza-dashboard-feature.mjs

@@ -28,8 +28,7 @@ import { AppSearch } from '@esfaenza/es-table';
  * Token di registrazione della DashboardFeatureService.
  * Permette di fare l'override dell'implementazione di default a scopo di test delle widget
  */
-const DSH_DATA_SERVICE = new InjectionToken('DSH_DATA_SERVICE');
-
+const DSH_DATA_SERVICE = new InjectionToken('DSH_DATA_SERVICE');
 const DSH_OPTIONS = new InjectionToken('DSH_MODULE_OPTIONS');
 
 class JaceChartWidgetComponent {
@@ -116,7 +115,7 @@ class JaceCounterWidgetComponent {
         this.dataReady = false;
         this.lastdate = "";
     }
-    //TODO per online update: importare cdr: ChangeDectectorRef 
+    //TODO per online update: importare cdr: ChangeDectectorRef
     setWidgetModel(dshBackendId, widgetModel) {
         this.model = widgetModel;
         if (this.model.backendid === undefined || this.model.backendid == "default_backend")
@@ -153,7 +152,7 @@ class JaceCounterWidgetComponent {
             if (this.model) {
                 this.model.setData(data);
                 this.dataReady = true;
-                //TODO per online update: this.cdr.markForCheck();                
+                //TODO per online update: this.cdr.markForCheck();
             }
         });
     }
@@ -521,7 +520,7 @@ class DashboardWidgetFactory {
         }
     }
     /**
-     * Versione ng11 della creazione dei componenti dinamici delle widget
+     * Versione ng13+ della creazione dei componenti dinamici delle widget
      * @param type
      * @param vcr
      * @returns
@@ -617,7 +616,7 @@ class DashboardComponent {
     ngOnChanges(changes) {
         //occhio: arriva prima di ngAfterViewInit
         if (changes.Configuration) {
-            //appena ho configuration            
+            //appena ho configuration
             console.log(changes.Configuration);
             // la prima volta l'ho già fatta alla creazione del componente
             if (!changes.Configuration.firstChange) {
@@ -727,6 +726,14 @@ class DashboardFeatureAPIDataService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Recupera la dashboard specificata dal backend specificato per l'account specificato.
+     * Usata dal component DashboardComponent
+     * @param backendid id del backend che pubblica questa dashboard
+     * @param idaccount idaccount dell'utente che sta visitando questa dashboard
+     * @param dashboardName identificativo della dashboard da recuperare
+     * @returns JaceDashboardLayoutDetail layout della dashboard
+     */
     GetUserDashboard(backendid, idaccount, dashboardName) {
         let params = new HttpParams();
         params = params.append("backendid", backendid.toString());
@@ -734,9 +741,21 @@ class DashboardFeatureAPIDataService {
         params = params.append("name", dashboardName);
         return this.http.get(Repository["GET_Dashboard_GetLayout"], params);
     }
+    /**
+     *Salva le impostazioni della dashboard (es. preferenze specifiche dell'utente)
+     * @param dto dati di salvataggio
+     * @returns CallResult
+     */
     SaveUserDashboard(dto) {
         return this.http.post(Repository["POST_Dashboard_SaveLayout"], dto);
     }
+    /**
+     * Recupera i dati di una specifica Widget. Chiamato dal metodo refreshData() di BaseWidgetComponent.
+     * @param backendid id del backend che pubblica i dati di questa Widget
+     * @param name nome univoco di questa Widget
+     * @param options dizionario di configurazioni impostate sulla specifica Widget (aka configurazioni particolari)
+     * @returns Un oggetto any con i dati della Widget (Nota: ogni Widget è responsabile di interpretare i propri dati)
+     */
     GetWidgetData(backendid, name, options) {
         let params = new HttpParams();
         params = params.append("backendid", backendid.toString());
@@ -917,6 +936,9 @@ class BaseWidgetComponent {
         this.refreshData();
     }
     ngOnInit() { }
+    /**
+     * Ascolta i cambiamenti sull'input DashboardDate e, se è cambiata, lancia refreshData()
+     */
     ngOnChanges(changes) {
         //console.log(changes['DashboardDate'].currentValue);
         if (changes['DashboardDate'].previousValue)
@@ -931,8 +953,8 @@ class BaseWidgetComponent {
         }
     }
     /**
-     * Prepara i parametri e lancia la chiamata GetWidgetData della DashboardFeatureService.
-     * Imposta il model con i dati restituiti (setData) e imposta la variabile dataReady del campo a true
+     * Prepara i parametri e lancia la chiamata GetWidgetData della service DashboardFeatureService.
+     * Imposta il model con i dati restituiti (setData) ed imposta il campo dataReady del component a true
      */
     refreshData() {
         if (!this.model)
@@ -998,5 +1020,5 @@ var JaceWidgetTypes;
  * Generated bundle index. Do not edit.
  */
 
-export { BaseJaceWidgetModel, BaseWidgetComponent, DSH_DATA_SERVICE, DashboardComponent, DashboardFeatureAPIDataService, DashboardFeatureModule, DashboardWidgetFactory, DefaultDashboardModuleOptions, JaceChartWidgetComponent, JaceCounterWidgetComponent, JaceDashboardConfig, JaceDashboardLayoutAppSearch, JaceDashboardLayoutDetail, JaceListWidgetComponent, JaceMultiprogWidgetComponent, JaceWidgetInstanceDetail, JaceWidgetTypes, SaveJaceDashboardLayoutDTO };
+export { BaseJaceWidgetModel, BaseWidgetComponent, DSH_DATA_SERVICE, DSH_OPTIONS, DashboardComponent, DashboardFeatureAPIDataService, DashboardFeatureModule, DashboardWidgetFactory, DefaultDashboardModuleOptions, JaceChartWidgetComponent, JaceCounterWidgetComponent, JaceDashboardConfig, JaceDashboardLayoutAppSearch, JaceDashboardLayoutDetail, JaceListWidgetComponent, JaceMultiprogWidgetComponent, JaceWidgetInstanceDetail, JaceWidgetTypes, SaveJaceDashboardLayoutDTO };
 //# sourceMappingURL=esfaenza-dashboard-feature.mjs.map