mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Insights dependency and documentation improvements (#9815)
This commit is contained in:
Denys Vuika
GitHub
@@ -1,34 +0,0 @@
|
||||
---
|
||||
Title: Analytics Generator Component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Analytics Generator Component](../../../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts")
|
||||
|
||||
Generates and shows charts
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics-generator
|
||||
[reportId]="reportId"
|
||||
[reportParamQuery]="reportParamQuery">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| reportId | `string` | | 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. |
|
||||
1
docs/insights/components/analytics-generator.component.md
Symbolic link
1
docs/insights/components/analytics-generator.component.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../lib/insights/docs/components/analytics-generator.component.md
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
Title: APS Analytics List Component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [APS Analytics List Component](../../../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts "Defined in analytics-report-list.component.ts")
|
||||
|
||||
Shows a list of all available reports
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics-report-list
|
||||
[layoutType]="'LIST'">
|
||||
</adf-analytics-report-list>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### 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`](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. |
|
||||
1
docs/insights/components/analytics-report-list.component.md
Symbolic link
1
docs/insights/components/analytics-report-list.component.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../lib/insights/docs/components/analytics-report-list.component.md
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
Title: APS Analytics Component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [APS Analytics Component](../../../lib/insights/src/lib/analytics-process/components/analytics.component.ts "Defined in analytics.component.ts")
|
||||
|
||||
Shows the charts related to the reportId passed as input
|
||||
|
||||
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics
|
||||
[appId]="1001"
|
||||
[reportId]="2006">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### 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`](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. |
|
||||
1
docs/insights/components/analytics.component.md
Symbolic link
1
docs/insights/components/analytics.component.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../lib/insights/docs/components/analytics.component.md
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
Title: Diagram Component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Diagram Component](../../../lib/insights/src/lib/diagram/components/diagram.component.ts "Defined in diagram.component.ts")
|
||||
|
||||
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>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### 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`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | success. |
|
||||
1
docs/insights/components/diagram.component.md
Symbolic link
1
docs/insights/components/diagram.component.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../lib/insights/docs/components/diagram.component.md
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
Title: Widget component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
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](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) classes.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```ts
|
||||
import { Component } from '@angular/core';
|
||||
import { WidgetComponent } from '@alfresco/adf-core';
|
||||
|
||||
@Component({
|
||||
selector: 'custom-editor',
|
||||
template: `
|
||||
<div style="color: red">Look, I'm a custom editor!</div>
|
||||
`
|
||||
})
|
||||
export class CustomEditorComponent extends WidgetComponent {}
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| field | `any` | | field. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | fieldChanged. |
|
||||
|
||||
## Details
|
||||
|
||||
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)
|
||||
Reference in New Issue
Block a user