inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-08 14:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2764] Updated process services docs with latest features (#3390)

Browse Source
This commit is contained in:
Andy Stark
2018-05-24 17:10:35 +01:00
committed by Eugenio Romano
parent a2581417bd
commit 04e50eeabd
33 changed files with 576 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/process-services/process-list.component.md
View File

@@ -1,7 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-04-16
Last reviewed: 2018-05-24
---
# Process Instance List
@@ -23,28 +23,28 @@ Renders a list containing all the process instances matched by the parameters sp
### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| appId | number | | The id of the app. |
| processDefinitionKey | string | | The processDefinitionKey of the process. |
| presetColumn | string | | Name of a custom schema to fetch from `app.config.json`. |
| state | string | | Define state of the processes. Possible values are `running`, `completed` and `all` |
| sort | string | | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` |
| name | string | | The name of the list. |
| page | number | 0 | The page of the processes to fetch. |
| size | number | 25 | The number of processes to fetch. |
| data | DataTableAdapter | | Data source to define the datatable. |
| multiselect | boolean | false | Toggles multiple row selection, renders checkboxes at the beginning of each row. |
| selectionMode | string | 'single' | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| selectFirstRow | boolean | true | Toggles default selection of the first row. |
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| appId | `number` | | The id of the app. |
| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. |
| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row |
| name | `string` | | The name of the list. |
| page | `number` | 0 | The page number of the processes to fetch. |
| presetColumn | `string` | | Name of a custom schema to fetch from `app.config.json`. |
| processDefinitionKey | `string` | | The processDefinitionKey of the process. |
| selectFirstRow | `boolean` | true | Toggles default selection of the first row |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| size | `number` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of processes to fetch in each page. |
| sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. |
| state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| rowClick | `EventEmitter<string>` | Emitted when a row in the process list is clicked |
| success | `EventEmitter<ProcessListModel>` | Emitted when the list of process instances has been loaded successfully from the server |
| error | `EventEmitter<any>` | Emitted when an error is encountered loading the list of process instances from the server |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
| rowClick | `EventEmitter<string>` | Emitted when a row in the process list is clicked. |
| success | [`EventEmitter<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts) | Emitted when the list of process instances has been loaded successfully from the server. |
## Details