inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update 3.6.0 (#5257)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/insights/components/analytics-generator.component.md
View File

@@ -23,12 +23,12 @@ Generates and shows charts
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| reportId | `number` | | |
| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/reportQuery.model.ts) | undefined | |
| reportId | `number` | | reportId. |
| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/reportQuery.model.ts) | undefined | reportParamQuery. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. |

12
docs/insights/components/analytics-report-list.component.md
View File

@@ -22,14 +22,14 @@ Shows a list of all available reports
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appId | `number` | | |
| layoutType | `string` | | |
| selectFirst | `boolean` | false | |
| appId | `number` | | appId ID of the target app. |
| layoutType | `string` | | layout Type LIST or GRID. |
| selectFirst | `boolean` | false | selectFirst. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/reportParameters.model.ts)`>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. |
| reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/reportParameters.model.ts)`>` | report Click. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. |

12
docs/insights/components/analytics.component.md
View File

@@ -25,14 +25,14 @@ Shows the charts related to the reportId passed as input
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appId | `number` | | |
| hideParameters | `boolean` | false | |
| reportId | `number` | | |
| appId | `number` | | appId ID of the target app. |
| hideParameters | `boolean` | false | hideParameters. |
| reportId | `number` | | reportId. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when editReport. |
| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when reportDeleted. |
| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when reportSaved. |

18
docs/insights/components/diagram.component.md
View File

@@ -32,17 +32,17 @@ The below component shows the diagram of a running process instance with the act
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| height | `number` | 500 | |
| metricColor | `any` | | |
| metricPercentages | `any` | | |
| metricType | `string` | "" | |
| processDefinitionId | `any` | | |
| processInstanceId | `any` | | |
| width | `number` | 1000 | |
| 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`](https://angular.io/api/core/EventEmitter)`<>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. |

6
docs/insights/components/widget.component.md
View File

@@ -7,7 +7,7 @@ Last reviewed: 2018-03-29
# [Widget component](../../../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts "Defined in widget.component.ts")
Base class for standard and custom widget classes.
Base class for standard and custom [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) classes.
## Basic Usage
@@ -30,13 +30,13 @@ export class CustomEditorComponent extends WidgetComponent {}
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| field | `any` | | Data to be displayed in the field |
| field | `any` | | field. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | ( |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | fieldChanged. |
## Details