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,19 +1,6 @@
|
||||
# Alfresco insights
|
||||
# Alfresco Insights Components
|
||||
|
||||
Contains a variety of components, directives and services used throughout ADF
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Documentation](#documentation)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install](#install)
|
||||
- [License](#license)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
Contains a variety of components, directives and services used throughout ADF to provide insights into the data stored in Alfresco.
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -33,6 +20,11 @@ necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng
|
||||
npm install @alfresco/adf-insights
|
||||
```
|
||||
|
||||
## License
|
||||
## Components
|
||||
|
||||
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
|
||||
| Name | Description |
|
||||
|------------------------------------------------------------------------------------|----------------------------------------------------------|
|
||||
| [Analytics Generator Component](docs/components/analytics-generator.component.md) | Generates and shows charts |
|
||||
| [APS Analytics List Component](docs/components/analytics-report-list.component.md) | Shows a list of all available reports |
|
||||
| [APS Analytics Component](docs/components/analytics.component.md) | Shows the charts related to the reportId passed as input |
|
||||
| [Diagram Component](docs/components/diagram.component.md) | Displays process diagrams. |
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# Analytics Generator Component
|
||||
|
||||
Generates and shows charts for a specific report.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics-generator
|
||||
[reportId]="reportId"
|
||||
[reportParamQuery]="reportParamQuery">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```ts
|
||||
import { AnalyticsGeneratorComponent } from '@alfresco/adf-insights';
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|------------------|---------------|---------------|-------------------|
|
||||
| reportId | `string` | | reportId. |
|
||||
| reportParamQuery | `ReportQuery` | undefined | reportParamQuery. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------|---------------------|-------------|
|
||||
| error | `EventEmitter<any>` | error. |
|
||||
| success | `EventEmitter<any>` | success. |
|
||||
@@ -0,0 +1,33 @@
|
||||
# Analytics Report List Component
|
||||
|
||||
Shows a list of all available reports
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics-report-list
|
||||
[layoutType]="'LIST'">
|
||||
</adf-analytics-report-list>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```ts
|
||||
import { AnalyticsReportListComponent } from '@alfresco/adf-insights';
|
||||
```
|
||||
|
||||
### 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<any>` | error. |
|
||||
| reportClick | `EventEmitter<ReportParametersModel>` | report Click. |
|
||||
| success | `EventEmitter<any>` | success. |
|
||||
30
lib/insights/docs/components/analytics.component.md
Normal file
30
lib/insights/docs/components/analytics.component.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Analytics Component
|
||||
|
||||
Shows the charts for a specific report and application.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics
|
||||
[appId]="1001"
|
||||
[reportId]="2006">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### 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<any>` | emitted when editReport. |
|
||||
| reportDeleted | `EventEmitter<any>` | emitted when reportDeleted. |
|
||||
| reportSaved | `EventEmitter<any>` | emitted when reportSaved. |
|
||||
46
lib/insights/docs/components/diagram.component.md
Normal file
46
lib/insights/docs/components/diagram.component.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Diagram Component
|
||||
|
||||
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>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```ts
|
||||
import { DiagramComponent } from '@alfresco/adf-insights';
|
||||
```
|
||||
|
||||
### 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<any>` | error. |
|
||||
| success | `EventEmitter<any>` | success. |
|
||||
@@ -19,5 +19,12 @@
|
||||
"styleIncludePaths": [
|
||||
"../core/src/lib"
|
||||
]
|
||||
}
|
||||
},
|
||||
"allowedNonPeerDependencies": [
|
||||
"@alfresco/adf-core",
|
||||
"@ngx-translate/core",
|
||||
"chart.js",
|
||||
"ng2-charts",
|
||||
"raphael"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -10,18 +10,20 @@
|
||||
"bugs": {
|
||||
"url": "https://github.com/Alfresco/alfresco-ng2-components/issues"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@angular/common": ">=14.1.3",
|
||||
"@angular/compiler": ">=14.1.3",
|
||||
"@angular/core": ">=14.1.3",
|
||||
"@angular/forms": ">=14.1.3",
|
||||
"@angular/material": ">=14.1.2",
|
||||
"dependencies": {
|
||||
"@alfresco/adf-core": ">=6.9.0",
|
||||
"@ngx-translate/core": ">=14.0.0",
|
||||
"chart.js": "^4.3.0",
|
||||
"ng2-charts": "^4.1.1",
|
||||
"raphael": ">=2.3.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@angular/common": ">=14.1.3",
|
||||
"@angular/compiler": ">=14.1.3",
|
||||
"@angular/core": ">=14.1.3",
|
||||
"@angular/forms": ">=14.1.3",
|
||||
"@angular/material": ">=14.1.2"
|
||||
},
|
||||
"keywords": [
|
||||
"analytics",
|
||||
"alfresco-component",
|
||||
|
||||
Reference in New Issue
Block a user