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:
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. |
|
Reference in New Issue
Block a user