Add basic Analytics documentation #951

ng2-components/ng2-activiti-analytics/README.md

@@ -23,6 +23,31 @@ Also make sure you include these dependencies in your `index.html` file:
     <script src="node_modules/chart.js/dist/Chart.bundle.min.js"></script>
 ```
 
+#### Moment
+
+```sh
+npm install moment --save
+```
+
+Also make sure you include these dependencies in your `index.html` file:
+
+```html
+    <script src="node_modules/moment/min/moment.min.js"></script>
+```
+
+
+#### Material Design Date picker
+
+```sh
+npm install md-date-time-picker --save
+```
+
+Also make sure you include these dependencies in your `index.html` file:
+
+```html
+    <script src="node_modules/md-date-time-picker/dist/js/mdDateTimePicker.min.js"></script>
+```
+
 #### Material Design Lite
 
 The style of this component is based on [material design](https://getmdl.io/), so if you want to visualize it correctly you have to add the material
@@ -41,17 +66,34 @@ Also make sure you include these dependencies in your `index.html` file:
 <link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
 ```
 
-## Basic usage example Activiti Analytics
+## Basic usage example Activiti Analytics List
-
+The component shows the list of all the available reports
 ```html
-<activiti-analytics></activiti-analytics>
+<analytics-report-list></analytics-report-list>
 ```
 
 #### Events
-
+**onSuccess**: The event is emitted when the report list are loaded<br />
+**onError**: The event is emitted when an error occur during the loading<br />
+**reportClick**: The event is emitted when the report in the list is selected<br />
 
 #### Options
+No options.
 
+## Basic usage example Activiti Analytics
+The component shows the charts related to the reportId passed as input
+```html
+<activiti-analytics [appId]="appId" [reportId]="reportId"></activiti-analytics>
+```
+
+#### Events
+**onSuccess**: The event is emitted when the report parameters are loaded<br />
+**onError**: The event is emitted when an error occur during the loading<br />
+
+#### Options
+**appId**: The application id<br />
+**reportId**: The report id<br />
+**debug**: Flag to enable or disable the Form values in the console log<br />
 
 ## Build from sources
 

ng2-components/ng2-activiti-analytics/src/components/analytics.component.spec.ts

@@ -94,7 +94,7 @@ describe('Test ng2-activiti-analytics Report ', () => {
         });
 
         it('Should render the Process definition overview report ', (done) => {
-            component.onShowReport.subscribe((res) => {
+            component.onSuccess.subscribe((res) => {
                 expect(res).toBeDefined();
                 expect(res.length).toEqual(3);
 
@@ -133,7 +133,7 @@ describe('Test ng2-activiti-analytics Report ', () => {
         });
 
         it('Should render the Task overview report ', (done) => {
-            component.onShowReport.subscribe((res) => {
+            component.onSuccess.subscribe((res) => {
                 expect(res).toBeDefined();
                 expect(res.length).toEqual(2);
 

ng2-components/ng2-activiti-analytics/src/components/analytics.component.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Component, EventEmitter, OnInit, OnChanges, Input, Output, SimpleChanges } from '@angular/core';
+import { Component, EventEmitter, OnChanges, Input, Output, SimpleChanges } from '@angular/core';
 import { AlfrescoTranslationService } from 'ng2-alfresco-core';
 import { AnalyticsService } from '../services/analytics.service';
 import { ReportQuery } from '../models/report.model';
@@ -27,7 +27,7 @@ import { Chart } from '../models/chart.model';
     templateUrl: './analytics.component.html',
     styleUrls: ['./analytics.component.css']
 })
-export class AnalyticsComponent implements  OnInit, OnChanges {
+export class AnalyticsComponent implements OnChanges {
 
     @Input()
     appId: string;
@@ -41,9 +41,6 @@ export class AnalyticsComponent implements  OnInit, OnChanges {
     @Output()
     onSuccess = new EventEmitter();
 
-    @Output()
-    onShowReport = new EventEmitter();
-
     @Output()
     onError = new EventEmitter();
 
@@ -59,9 +56,6 @@ export class AnalyticsComponent implements  OnInit, OnChanges {
         }
     }
 
-    ngOnInit() {
-    }
-
     ngOnChanges(changes: SimpleChanges) {
         this.reset();
     }
@@ -71,7 +65,7 @@ export class AnalyticsComponent implements  OnInit, OnChanges {
         this.analyticsService.getReportsByParams(this.reportId, this.reportParamQuery).subscribe(
             (res: Chart[]) => {
                 this.reports = res;
-                this.onShowReport.emit(res);
+                this.onSuccess.emit(res);
             },
             (err: any) => {
                 this.onError.emit(err);