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

[ADF-3323] Fixed broken links in doc files (#3662)

Browse Source 
* [ADF-3323] Fixed URL path to Typescript source files

* [ADF-3323] Fixed and checked broken links caused by previous bug
This commit is contained in:
Andy Stark
2018-08-07 16:00:58 +01:00
committed by Eugenio Romano
parent fd5978e81b
commit e03f3a1a6b
125 changed files with 845 additions and 829 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/insights/analytics-generator.component.md
View File

@@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Analytics Generator Component
Generates and shows charts
@@ -22,11 +23,11 @@ Generates and shows charts
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| reportId | `number` | | |
| reportParamQuery | `ReportQuery` | `undefined` | |
| reportParamQuery | [`ReportQuery`](../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<{}>` | |
| error | `EventEmitter<{}>` | |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |

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

@@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Activiti Analytics List Component
Shows a list of all available reports
@@ -20,14 +21,14 @@ Shows a list of all available reports
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| layoutType | `string` | `AnalyticsReportListComponent.LAYOUT_LIST` | |
| appId | `number` | | |
| selectFirst | `boolean` | `false` | |
| layoutType | `string` | | |
| selectFirst | `boolean` | false | |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| reportClick | `EventEmitter<ReportParametersModel>` | |
| success | `EventEmitter<{}>` | |
| error | `EventEmitter<{}>` | |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../lib/insights/diagram/models/report/reportParameters.model.ts)`>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |

9
docs/insights/analytics.component.md
View File

@@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Activiti Analytics Component
Shows the charts related to the reportId passed as input
@@ -24,13 +25,13 @@ Shows the charts related to the reportId passed as input
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appId | `number` | | |
| hideParameters | `boolean` | false | |
| reportId | `number` | | |
| hideParameters | `boolean` | `false` | |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| editReport | `EventEmitter<{}>` | |
| reportSaved | `EventEmitter<{}>` | |
| reportDeleted | `EventEmitter<{}>` | |
| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |

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

@@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Diagram Component
Displays process diagrams.
@@ -28,18 +29,19 @@ The below component shows the diagram of a running process instance with the act
### Properties
| Name | Type | Description |
| --- | --- | -- |
| metricPercentages | any | The array that contains the percentage of time for each element |
| processInstanceId | any | |
| metricColor | any | The array that contains the color for each element |
| metricType | any | The string that specifies the metric type |
| width | number | |
| height | number | |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| height | `number` | 500 | |
| metricColor | `any` | | |
| metricPercentages | `any` | | |
| metricType | `string` | "" | |
| processDefinitionId | `any` | | |
| processInstanceId | `any` | | |
| width | `number` | 1000 | |
### Events
| Name | Description |
| --- | --- |
| success | Raised when the diagrams elements are loaded |
| error | Raised when an error occurs during loading |
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |

9
docs/insights/widget.component.md
View File

@@ -28,15 +28,14 @@ export class CustomEditorComponent extends WidgetComponent {}
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| field | [`FormFieldModel`](../core/form-field.model.md) | | Data to be displayed in the field |
| readOnly | `boolean` | false | Does the widget show a read-only value? (ie, can't be edited) |
| ---- | ---- | ------------- | ----------- |
| field | `any` | | Data to be displayed in the field |
### Events
| Name | Type | Description |
| -- | -- | -- |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`>` | (**Deprecated:** Used only to trigger visibility engine; components should do that internally if needed) |
| ---- | ---- | ----------- |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | ( |
## Details