mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Reviewed latest proc services cloud docs (#4122)
This commit is contained in:
committed by
Eugenio Romano
parent
7dde329d81
commit
78abcc93df
@@ -16,21 +16,28 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [App list cloud component](app-list-cloud.component.md) | Shows all deployed cloud application instances. | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-list-cloud.component.ts) |
|
||||
| [Process list cloud component](process-list-cloud.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/process-list-cloud/components/process-list-cloud.component.ts) |
|
||||
| [Task filters cloud component](task-filters-cloud.component.md) | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts) |
|
||||
| [Task list cloud component](task-list-cloud.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task-list-cloud/components/task-list-cloud.component.ts) |
|
||||
| _[App details cloud component](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts) |
|
||||
| _[Process filters cloud component](../process-services-cloud/process-filters-cloud.component.md)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts) |
|
||||
| [App list cloud component](app-list-cloud.component.md) | Shows all deployed cloud application instances. | [Source](../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) |
|
||||
| [Edit process filter cloud component](edit-process-filter-cloud.component.md) | Shows Process Filter Details. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
|
||||
| [Process filters cloud component](process-filters-cloud.component.md) | Lists all available process filters and allows to select a filter. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) |
|
||||
| [Process list cloud component](process-list-cloud.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) |
|
||||
| [Start process cloud component](start-process-cloud.component.md) | Starts a process. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) |
|
||||
| [Start task cloud component](start-task-cloud.component.md) | Creates/starts a new task for the specified app. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) |
|
||||
| [Edit task filter cloud component](edit-task-filter-cloud.component.md) | Edits Task Filter Details. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
|
||||
| [Task filters cloud component](task-filters-cloud.component.md) | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
|
||||
| [Task list cloud component](task-list-cloud.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) |
|
||||
| _[App details cloud component](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) |
|
||||
| _[People cloud component](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| _[Apps process cloud service](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts) |
|
||||
| _[Process filter cloud service](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts) |
|
||||
| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts) |
|
||||
| _[Task filter cloud service](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts) |
|
||||
| _[Task list cloud service](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts) |
|
||||
| _[Apps process cloud service](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
|
||||
| _[Process filter cloud service](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
|
||||
| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||
| _[Start process cloud service](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||
| _[Start task cloud service](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||
| _[Task filter cloud service](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| _[Task list cloud service](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
|
@@ -2,10 +2,10 @@
|
||||
Title: App List Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-18-10
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [App List Cloud Component](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-list-cloud.component.ts "Defined in app-list-cloud.component.ts")
|
||||
# [App List Cloud Component](../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts "Defined in app-list-cloud.component.ts")
|
||||
|
||||
Shows all deployed cloud application instances.
|
||||
|
||||
@@ -43,4 +43,4 @@ You can show custom content when there are no apps available by supplying an
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/src/lib/app-list-cloud/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. |
|
||||
| appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. |
|
||||
|
@@ -2,10 +2,10 @@
|
||||
Title: Edit Process Filter Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-20-11
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Edit Process Filter Cloud component](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
|
||||
# [Edit Process Filter Cloud component](../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
|
||||
|
||||
Shows Process Filter Details.
|
||||
|
||||
@@ -25,14 +25,14 @@ Shows Process Filter Details.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | | The name of the application. |
|
||||
| id | `string` | | Id of the process filter. |
|
||||
| id | `string` | | Id of the process instance filter. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterActionType`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts)`>` | Emitted when an filter action occurs i.e Save, SaveAs, Delete. |
|
||||
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts)`>` | Emitted when an process instance filter property changes. |
|
||||
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterActionType`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when an filter action occurs i.e Save, SaveAs, Delete. |
|
||||
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when an process instance filter property changes. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -2,12 +2,12 @@
|
||||
Title: Edit Task Filter Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-20-11
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# Edit Task Filter Cloud component
|
||||
# [Edit Task Filter Cloud component](../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts")
|
||||
|
||||
Shows Task Filter Details.
|
||||
Edits Task Filter Details.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -24,15 +24,15 @@ Shows Task Filter Details.
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| id | `string` | "" | The id of the Task filter. |
|
||||
| appName | `string` | "" | The name of the application. |
|
||||
| appName | `string` | | Name of the app. |
|
||||
| id | `string` | | ID of the task filter. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task-cloud/models/filter-cloud.model.ts)`>` | Emitted when a filter properties changed. |
|
||||
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterActionType`](../../lib/process-services-cloud/src/lib/task-cloud/models/filter-cloud.model.ts)`>` | Emitted when the task filter action clicked (i.e, save, saveAs, Delete). |
|
||||
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterActionType`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
|
||||
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -1,10 +1,11 @@
|
||||
---
|
||||
Title: Process Filters Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-21-11
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Process Filters Cloud Component](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts "Defined in process-filters-cloud.component.ts")
|
||||
# [Process Filters Cloud Component](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts "Defined in process-filters-cloud.component.ts")
|
||||
|
||||
Lists all available process filters and allows to select a filter.
|
||||
|
||||
@@ -24,32 +25,13 @@ Lists all available process filters and allows to select a filter.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | | (required) The application name |
|
||||
| filterParam | `ProcessFilterCloudModel` | | (optional) The filter to be selected by default |
|
||||
| showIcons | `boolean` | false | (optional) The flag hides/shows icon against each filter |
|
||||
| filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default |
|
||||
| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when filters are loaded successfully. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs while loading the filters. |
|
||||
|
||||
### Details
|
||||
|
||||
The `filterParam` input can be used to select a filter as mentioned below.
|
||||
|
||||
```html
|
||||
<adf-cloud-process-filters
|
||||
[filterParam]="{name:'Running Processes'}">
|
||||
</adf-cloud-process-filters>
|
||||
```
|
||||
|
||||
A filter can be selected by using any of the `ProcessFilterCloudModel` property.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| id | string | The id of the filter |
|
||||
| name | string | The name of the filter |
|
||||
| key | string | The key of the filter |
|
||||
| index | string | The zero-based position of the filter in the array |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs while loading the filters |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when filters are loaded successfully |
|
||||
|
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2018-11-09
|
||||
---
|
||||
|
||||
# [Process Instance List Cloud component](../../lib/process-services-cloud/src/lib/process-list-cloud/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
|
||||
# [Process Instance List Cloud component](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
|
||||
|
||||
Renders a list containing all the process instances matched by the parameters specified.
|
||||
|
||||
@@ -66,7 +66,7 @@ when the process list is empty:
|
||||
| serviceName | `string` | "" | Filter the processes to display only the ones with this serviceName value. |
|
||||
| serviceType | `string` | "" | Filter the processes to display only the ones with this serviceType value. |
|
||||
| serviceVersion | `string` | "" | Filter the processes to display only the ones with this serviceVersion value. |
|
||||
| sorting | [`ProcessListCloudSortingModel`](../../lib/process-services-cloud/src/lib/process-list-cloud/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. |
|
||||
| sorting | [`ProcessListCloudSortingModel`](../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. |
|
||||
| status | `string` | "" | Filter the processes to display only the ones with this status. |
|
||||
|
||||
### Events
|
||||
|
@@ -1,8 +1,15 @@
|
||||
# Start Process Cloud Component
|
||||
---
|
||||
Title: Start Process Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Start Process Cloud Component](../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts "Defined in start-process-cloud.component.ts")
|
||||
|
||||
Starts a process.
|
||||
|
||||

|
||||

|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -18,19 +25,19 @@ Starts a process.
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | | Limit the list of processes that can be started to those contained in the specified app. |
|
||||
| name | `string` | "" | (optional) Name to assign to the current process. |
|
||||
| processDefinitionName | `string` | | (optional) Definition name of the process to start. |
|
||||
| showSelectProcessDropdown | `boolean` | true | (optional) Hide or show the process selection dropdown. |
|
||||
| variables | `Map<string, any>[]` | | (optional) Variables in the input to the process. |
|
||||
| appName | `string` | | (required) Name of the app. |
|
||||
| name | `string` | "" | Name of the process. |
|
||||
| processDefinitionName | `string` | | Name of the process definition. |
|
||||
| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. |
|
||||
| variables | `Map<string, any>[]` | | Variables to attach to the payload. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when the process is canceled. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when the process starts. |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. |
|
||||
|
||||
## Details
|
||||
|
||||
|
@@ -1,12 +1,13 @@
|
||||
---
|
||||
Title: Start Task Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-23-10
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Start Task Cloud Component](../../lib/process-services-cloud/src/lib/start-task-cloud/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts")
|
||||
# [Start Task Cloud Component](../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts")
|
||||
|
||||
Creates/Starts new task for the specified app
|
||||
Creates/starts a new task for the specified app.
|
||||
|
||||

|
||||
|
||||
|
@@ -2,10 +2,10 @@
|
||||
Title: Task Filters Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-20-11
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Task Filters Cloud component](../../lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts "Defined in task-filters-cloud.component.ts")
|
||||
# [Task Filters Cloud component](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts "Defined in task-filters-cloud.component.ts")
|
||||
|
||||
Shows all available filters.
|
||||
|
||||
@@ -30,7 +30,7 @@ Shows all available filters.
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task-cloud/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
|
||||
|
||||
## Details
|
||||
|
@@ -2,10 +2,10 @@
|
||||
Title: Task List Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-28
|
||||
Last reviewed: 2019-01-08
|
||||
---
|
||||
|
||||
# [Task List Cloud component](../../lib/process-services-cloud/src/lib/task-list-cloud/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")
|
||||
# [Task List Cloud component](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")
|
||||
|
||||
Renders a list containing all the tasks matched by the parameters specified.
|
||||
|
||||
@@ -64,7 +64,7 @@ when the task list is empty:
|
||||
| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. |
|
||||
| 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 the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| sorting | [`TaskListCloudSortingModel`](../../lib/process-services-cloud/src/lib/task-list-cloud/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. |
|
||||
| sorting | [`TaskListCloudSortingModel`](../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. |
|
||||
| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. |
|
||||
|
||||
### Events
|
||||
@@ -82,7 +82,7 @@ This component displays lists of tasks related to the application name insterted
|
||||
|
||||
### Setting the column schema
|
||||
|
||||
You can use an HTML-based schema declaration to set a column schema for the tasklist as shown below :
|
||||
You can use an HTML-based schema declaration to set a column schema for the tasklist as shown below:
|
||||
|
||||
```html
|
||||
<adf-cloud-task-list ...>
|
||||
@@ -161,6 +161,8 @@ You can use an HTML-based schema and an `app.config.json` custom schema declarat
|
||||
</adf-cloud-task-list>
|
||||
```
|
||||
|
||||
<!-- {% endraw %} -->
|
||||
|
||||
### Setting Sorting Order for the list
|
||||
|
||||
You can specify a sorting order as shown in the example below:
|
||||
@@ -176,8 +178,6 @@ let sorting = { orderBy: 'created', direction: 'desc' };
|
||||
</adf-cloud-task-list>
|
||||
```
|
||||
|
||||
<!-- {% endraw %} -->
|
||||
|
||||
### Pagination strategy
|
||||
|
||||
The Tasklist also supports pagination as shown in the example below:
|
||||
|
Reference in New Issue
Block a user