alfresco-ng2-components/docs/process-services/process-instance-details.component.md

36 lines
1.1 KiB
Markdown

---
Added: v2.0.0
Status: Active
---
# Process Details component
Displays detailed information on a specified process instance
## Basic Usage
```html
<adf-process-instance-details
processInstanceId="YOUR_PROCESS_INSTANCE_ID">
</adf-process-instance-details>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. |
| showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. |
| showTitle | `boolean` | true | Toggles whether to show or hide the title. |
### Events
| Name | Type | Description |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. |
| showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. |
| taskClick | [`EventEmitter<TaskDetailsEvent>`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. |