inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-08-07 17:48:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2135] Updated tables of contents (#2822)

Browse Source
This commit is contained in:
Andy Stark
2018-01-12 13:26:11 +00:00
committed by Eugenio Romano
parent 72cfd7894d
commit 69e40ea1c0
17 changed files with 164 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/process-list.component.md
View File

@@ -1,19 +1,6 @@
# Activiti Process Instance List
# Process Instance List
This component renders a list containing all the process instances matched by the parameters specified.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
Renders a list containing all the process instances matched by the parameters specified.
## Basic Usage
@@ -58,28 +45,26 @@ define custom schema in the app.config.json as shown below json format.
[presetColumn]="'customSchema'">
</adf-process-instance-list>
```
### Properties
| Name | Description |
| --- | --- |
| appId | The id of the app. |
| processDefinitionKey | The processDefinitionKey of the process. |
| presetColumn | string || The presetColumn of the custom schema to fetch. |
| state | Define state of the processes. Possible values are `running`, `completed` and `all` |
| sort | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` |
| schemaColumn | List of columns to display in the process instances datatable (see the [Details](#details) section below) |
| Name | Description | | |
| ---- | ----------- | --- | --- |
| appId | The id of the app. | | |
| processDefinitionKey | The processDefinitionKey of the process. | | |
| presetColumn | string | | The presetColumn of the custom schema to fetch. |
| state | Define state of the processes. Possible values are `running`, `completed` and `all` | | |
| sort | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` | | |
| schemaColumn | List of columns to display in the process instances datatable (see the [Details](#details) section below) | | |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| rowClick | Emitted when a row in the process list is clicked |
| success | Emitted when the list of process instances has been loaded successfully from the server |
| error | Emitted when an error is encountered loading the list of process instances from the server |
## Details
Example value for the schemaColumn property (see [Properties](#properties) section above):