mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1549] Added doc files for remaining Activiti libraries (#2354)
This commit is contained in:
committed by
Eugenio Romano
parent
99f12b18a4
commit
1b3c8ac6ee
49
docs/diagram.component.md
Normal file
49
docs/diagram.component.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Activiti Diagram Component
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## 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>
|
||||
```
|
||||
|
||||
### 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 | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| onSuccess | Raised when the diagrams elements are loaded |
|
||||
| onError | Raised when an error occurs during loading |
|
Reference in New Issue
Block a user