mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Restructured remaining doc folders and fixed links (#4441)
* [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs * [ADF-4152] Updated links in user guide * [ADF-4152] Fixed broken links in tutorials * [ADF-4152] Fixed remaining links in core docs * [ADF-4152] Fixed remaining links in proc services docs * [ADF-4152] Fixed remaining links in content services docs * [ADF-4152] Fixed links in breaking changes docs * [ADF-4152] Updated main README index page * [ADF-4152] Fixed glitches with preview ext component docs
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
8edf92f325
commit
31479cfaa4
@@ -1,25 +0,0 @@
|
||||
---
|
||||
Title: Insights API
|
||||
Github only: true
|
||||
---
|
||||
|
||||
# Insights API
|
||||
|
||||
Contains components for Process Services analytics and diagrams.
|
||||
See the library's
|
||||
[README file](../../lib/insights/README.md)
|
||||
for more information about installing and using the source code.
|
||||
|
||||
<!--insights start-->
|
||||
|
||||
## Components
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../../lib/insights/analytics-process/components/widgets/widget.component.ts) |
|
||||
| [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../../lib/insights/analytics-process/components/analytics-generator.component.ts) |
|
||||
| [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
|
||||
| [Analytics component](analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../../lib/insights/analytics-process/components/analytics.component.ts) |
|
||||
| [Diagram component](diagram.component.md) | Displays process diagrams. | [Source](../../lib/insights/diagram/components/diagram.component.ts) |
|
||||
|
||||
<!--insights end-->
|
||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Analytics Generator Component](../../lib/insights/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts")
|
||||
# [Analytics Generator Component](../../../lib/insights/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts")
|
||||
|
||||
Generates and shows charts
|
||||
|
||||
@@ -24,7 +24,7 @@ Generates and shows charts
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| reportId | `number` | | |
|
||||
| reportParamQuery | [`ReportQuery`](../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | |
|
||||
| reportParamQuery | [`ReportQuery`](../../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [APS Analytics List Component](../../lib/insights/analytics-process/components/analytics-report-list.component.ts "Defined in analytics-report-list.component.ts")
|
||||
# [APS Analytics List Component](../../../lib/insights/analytics-process/components/analytics-report-list.component.ts "Defined in analytics-report-list.component.ts")
|
||||
|
||||
Shows a list of all available reports
|
||||
|
||||
@@ -31,5 +31,5 @@ Shows a list of all available reports
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| 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)`>` | |
|
||||
| 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>` | |
|
||||
@@ -4,11 +4,11 @@ Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [APS Analytics Component](../../lib/insights/analytics-process/components/analytics.component.ts "Defined in analytics.component.ts")
|
||||
# [APS Analytics Component](../../../lib/insights/analytics-process/components/analytics.component.ts "Defined in analytics.component.ts")
|
||||
|
||||
Shows the charts related to the reportId passed as input
|
||||
|
||||
|
||||
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Diagram Component](../../lib/insights/diagram/components/diagram.component.ts "Defined in diagram.component.ts")
|
||||
# [Diagram Component](../../../lib/insights/diagram/components/diagram.component.ts "Defined in diagram.component.ts")
|
||||
|
||||
Displays process diagrams.
|
||||
|
||||
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2018-03-29
|
||||
---
|
||||
|
||||
# [Widget component](../../lib/insights/analytics-process/components/widgets/widget.component.ts "Defined in widget.component.ts")
|
||||
# [Widget component](../../../lib/insights/analytics-process/components/widgets/widget.component.ts "Defined in widget.component.ts")
|
||||
|
||||
Base class for standard and custom widget classes.
|
||||
|
||||
@@ -40,10 +40,10 @@ export class CustomEditorComponent extends WidgetComponent {}
|
||||
|
||||
## Details
|
||||
|
||||
The [Widget component](../insights/widget.component.md) is the base class for all standard and custom form widgets. See the
|
||||
[Form Extensibility and Customisation](../user-guide/extensibility.md) page for full details about
|
||||
The [Widget component](widget.component.md) is the base class for all standard and custom form widgets. See the
|
||||
[Form Extensibility and Customisation](../../user-guide/extensibility.md) page for full details about
|
||||
implementing custom widgets.
|
||||
|
||||
## See also
|
||||
|
||||
- [Extensibility](../user-guide/extensibility.md)
|
||||
- [Extensibility](../../user-guide/extensibility.md)
|
||||
Reference in New Issue
Block a user