Insights dependency and documentation improvements (#9815)

lib/insights/docs/components/analytics-generator.component.md

@@ -0,0 +1,32 @@
+# Analytics Generator Component
+
+Generates and shows charts for a specific report.
+
+## Basic Usage
+
+```html
+<adf-analytics-generator 
+    [reportId]="reportId" 
+    [reportParamQuery]="reportParamQuery">
+</adf-analytics>
+```
+
+## API
+
+```ts
+import { AnalyticsGeneratorComponent } from '@alfresco/adf-insights';
+```
+
+### Properties
+
+| Name             | Type          | Default value | Description       |
+|------------------|---------------|---------------|-------------------|
+| reportId         | `string`      |               | reportId.         |
+| reportParamQuery | `ReportQuery` | undefined     | reportParamQuery. |
+
+### Events
+
+| Name    | Type                | Description |
+|---------|---------------------|-------------|
+| error   | `EventEmitter<any>` | error.      |
+| success | `EventEmitter<any>` | success.    |

lib/insights/docs/components/analytics-report-list.component.md

@@ -0,0 +1,33 @@
+# Analytics Report List Component
+
+Shows a list of all available reports
+
+## Basic Usage
+
+```html
+<adf-analytics-report-list
+    [layoutType]="'LIST'">
+</adf-analytics-report-list>
+```
+
+## API
+
+```ts
+import { AnalyticsReportListComponent } from '@alfresco/adf-insights';
+```
+
+### Properties
+
+| Name        | Type      | Default value | Description                 |
+|-------------|-----------|---------------|-----------------------------|
+| appId       | `number`  |               | appId ID of the target app. |
+| layoutType  | `string`  | LAYOUT_LIST   | layout Type LIST or GRID.   |
+| selectFirst | `boolean` | false         | selectFirst.                |
+
+### Events
+
+| Name        | Type                                  | Description   |
+|-------------|---------------------------------------|---------------|
+| error       | `EventEmitter<any>`                   | error.        |
+| reportClick | `EventEmitter<ReportParametersModel>` | report Click. |
+| success     | `EventEmitter<any>`                   | success.      |

lib/insights/docs/components/analytics.component.md

@@ -0,0 +1,30 @@
+# Analytics Component
+
+Shows the charts for a specific report and application.
+
+## Basic Usage
+
+```html
+<adf-analytics 
+    [appId]="1001" 
+    [reportId]="2006">
+</adf-analytics>
+```
+
+## API
+
+### Properties
+
+| Name           | Type      | Default value | Description                 |
+|----------------|-----------|---------------|-----------------------------|
+| appId          | `number`  |               | appId ID of the target app. |
+| hideParameters | `boolean` | false         | hideParameters.             |
+| reportId       | `string`  |               | reportId.                   |
+
+### Events
+
+| Name          | Type                | Description                 |
+|---------------|---------------------|-----------------------------|
+| editReport    | `EventEmitter<any>` | emitted when editReport.    |
+| reportDeleted | `EventEmitter<any>` | emitted when reportDeleted. |
+| reportSaved   | `EventEmitter<any>` | emitted when reportSaved.   |

lib/insights/docs/components/diagram.component.md

@@ -0,0 +1,46 @@
+# Diagram Component
+
+Displays process diagrams.
+
+## Basic Usage
+
+This component shows the diagram of a process.
+
+```html
+<adf-diagram 
+    [processDefinitionId]="processDefinitionId">
+</adf-diagram>
+```
+
+The below component shows the diagram of a running process instance with the activities highlighted according to their state (Active/Completed/Pending).
+
+```html
+<adf-diagram 
+    [processInstanceId]="processInstanceId">
+</adf-diagram>
+```
+
+## API
+
+```ts
+import { DiagramComponent } from '@alfresco/adf-insights';
+```
+
+### Properties
+
+| Name                | Type     | Default value | Description          |
+|---------------------|----------|---------------|----------------------|
+| height              | `number` | 500           | height.              |
+| metricColor         | `any`    |               | metricColor.         |
+| metricPercentages   | `any`    |               | metricPercentages.   |
+| metricType          | `string` | ""            | metricType.          |
+| processDefinitionId | `any`    |               | processDefinitionId. |
+| processInstanceId   | `any`    |               | processInstanceId.   |
+| width               | `number` | 1000          | width.               |
+
+### Events
+
+| Name    | Type                | Description |
+|---------|---------------------|-------------|
+| error   | `EventEmitter<any>` | error.      |
+| success | `EventEmitter<any>` | success.    |