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

Update Doc 4.1.0 (#6215)

Browse Source 
* docbuild

* docbuild

* doc license audit

* remove link redirect to testing
This commit is contained in:
Eugenio Romano
2020-10-08 18:33:57 +01:00
committed by GitHub
parent 2747b7fc13
commit d7db9adbf6
177 changed files with 2638 additions and 2121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

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

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

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

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

@@ -30,19 +30,19 @@ The below component shows the diagram of a running process instance with the act
### 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. |
| 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`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | success. |
| Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | success. |

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

@@ -28,14 +28,14 @@ export class CustomEditorComponent extends WidgetComponent {}
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| field | `any` | | field. |
| Name | Type | Default value | Description |
| ----- | ----- | ------------- | ----------- |
| field | `any` | | field. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| Name | Type | Description |
| ------------ | ----------------------------------------------------------------- | ------------- |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | fieldChanged. |
## Details