Documentation update 3.6.0 (#5257)

* documentation update 3.6.0

* documentation update 3.6.0

* update missing doc
This commit is contained in:
Eugenio Romano
2019-11-18 12:34:28 +00:00
committed by GitHub
parent 7ca2f5d1e9
commit a6ad7a5ad0
113 changed files with 421 additions and 374 deletions

View File

@@ -28,15 +28,19 @@ import { AnalyticsService } from '../services/analytics.service';
})
export class AnalyticsGeneratorComponent implements OnChanges {
/** reportId. */
@Input()
reportId: number;
/** reportParamQuery. */
@Input()
reportParamQuery: ReportQuery = undefined;
/** success. */
@Output()
success = new EventEmitter();
/** error. */
@Output()
error = new EventEmitter();

View File

@@ -25,12 +25,15 @@ import { AnalyticsService } from '../services/analytics.service';
})
export class AnalyticsReportHeatMapComponent implements OnInit {
/** reportId. */
@Input()
report: any;
/** success. */
@Output()
success = new EventEmitter();
/** error. */
@Output()
error = new EventEmitter();

View File

@@ -32,21 +32,27 @@ export class AnalyticsReportListComponent implements OnInit {
public static LAYOUT_LIST: string = 'LIST';
public static LAYOUT_GRID: string = 'GRID';
/** layout Type LIST or GRID. */
@Input()
layoutType: string = AnalyticsReportListComponent.LAYOUT_LIST;
/** appId ID of the target app. */
@Input()
appId: number;
/** selectFirst. */
@Input()
selectFirst: boolean = false;
/** report Click. */
@Output()
reportClick: EventEmitter<ReportParametersModel> = new EventEmitter<ReportParametersModel>();
/** success. */
@Output()
success = new EventEmitter();
/** error. */
@Output()
error = new EventEmitter();

View File

@@ -50,30 +50,39 @@ export class AnalyticsReportParametersComponent implements OnInit, OnChanges, On
public static FORMAT_DATE_ACTIVITI: string = 'YYYY-MM-DD';
/** appId ID of the target app. */
@Input()
appId: number;
/** reportId. */
@Input()
reportId: string;
/** hideComponent. */
@Input()
hideComponent: boolean = false;
/** success. */
@Output()
success = new EventEmitter();
/** error. */
@Output()
error = new EventEmitter();
/** edit. */
@Output()
edit = new EventEmitter();
/** form Value Changed. */
@Output()
formValueChanged = new EventEmitter();
/** save Report Success. */
@Output()
saveReportSuccess = new EventEmitter();
/** delete Report Success. */
@Output()
deleteReportSuccess = new EventEmitter();

View File

@@ -27,21 +27,27 @@ import { AnalyticsGeneratorComponent } from './analytics-generator.component';
})
export class AnalyticsComponent implements OnChanges {
/** appId ID of the target app. */
@Input()
appId: number;
/** reportId. */
@Input()
reportId: number;
/** hideParameters. */
@Input()
hideParameters: boolean = false;
/** emitted when editReport. */
@Output()
editReport = new EventEmitter();
/** emitted when reportSaved. */
@Output()
reportSaved = new EventEmitter();
/** emitted when reportDeleted. */
@Output()
reportDeleted = new EventEmitter();

View File

@@ -19,9 +19,11 @@ import { EventEmitter, Input, OnChanges, Output, SimpleChanges } from '@angular/
export class WidgetComponent implements OnChanges {
/** field. */
@Input()
field: any;
/** fieldChanged. */
@Output()
fieldChanged: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -28,30 +28,40 @@ import { RaphaelService } from './raphael/raphael.service';
templateUrl: './diagram.component.html'
})
export class DiagramComponent implements OnChanges {
/** processDefinitionId. */
@Input()
processDefinitionId: any;
/** processInstanceId. */
@Input()
processInstanceId: any;
/** metricPercentages. */
@Input()
metricPercentages: any;
/** metricColor. */
@Input()
metricColor: any;
/** metricType. */
@Input()
metricType: string = '';
/** width. */
@Input()
width: number = 1000;
/** height. */
@Input()
height: number = 500;
/** success. */
@Output()
success = new EventEmitter();
/** error. */
@Output()
error = new EventEmitter();