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

generate documentation (#7006)

Browse Source
This commit is contained in:
Eugenio Romano
2021-05-10 10:47:48 +01:00
committed by GitHub
parent 2d510776ea
commit d6a4f84161
68 changed files with 235 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/process-services-cloud/components/app-list-cloud.component.md
View File

@@ -53,4 +53,4 @@ For example :
| Name | Type | Description |
| ---- | ---- | ----------- |
| appClick | `any` | 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. |

4
docs/process-services-cloud/components/edit-process-filter-cloud.component.md
View File

@@ -58,8 +58,8 @@ Shows/edits process filter details.
| Name | Type | Description |
| ---- | ---- | ----------- |
| action | `any` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
| filterChange | `any` | Emitted when a process instance filter property changes. |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a 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 a process instance filter property changes. |
## Details

4
docs/process-services-cloud/components/edit-task-filter-cloud.component.md
View File

@@ -57,8 +57,8 @@ Edits task filter details.
| Name | Type | Description |
| ---- | ---- | ----------- |
| action | `any` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
| filterChange | `any` | Emitted when a task filter property changes. |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../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)`<>` | Emitted when a task filter property changes. |
## Details

10
docs/process-services-cloud/components/form-cloud.component.md
View File

@@ -102,12 +102,12 @@ The template defined inside `empty-form` will be shown when no form definition i
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | `any` | Emitted when form content is clicked. |
| formDataRefreshed | `any` | Emitted when form values are refreshed due to a data property change. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | `any` | Emitted when the form is loaded or reloaded. |
| formSaved | `any` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
## Details

8
docs/process-services-cloud/components/group-cloud.component.md
View File

@@ -51,10 +51,10 @@ Searches Groups.
| Name | Type | Description |
| ---- | ---- | ----------- |
| changedGroups | `any` | Emitted when a group selection change. |
| removeGroup | `any` | Emitted when a group is removed. |
| selectGroup | `any` | Emitted when a group is selected. |
| warning | `any` | Emitted when an warning occurs. |
| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. |
| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. |
| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. |
| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an warning occurs. |
## Details

10
docs/process-services-cloud/components/people-cloud.component.md
View File

@@ -31,7 +31,7 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username |
| readOnly | `boolean` | false | Show the info in readonly mode |
| roles | `string[]` | | Role names of the users to be listed. |
| searchUserCtrl | `any` | | FormControl to search the user |
| searchUserCtrl | `FormControl` | | FormControl to search the user |
| title | `string` | | Placeholder translation key |
| userChipsCtrl | `FormControl` | | FormControl to list of users |
| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. |
@@ -40,10 +40,10 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
| Name | Type | Description |
| ---- | ---- | ----------- |
| changedUsers | `any` | Emitted when a user selection change. |
| removeUser | `any` | Emitted when a selected user is removed in multi selection mode. |
| selectUser | `any` | Emitted when a user is selected. |
| warning | `any` | Emitted when an warning occurs. |
| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. |
| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. |
| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. |
| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an warning occurs. |
## Details

8
docs/process-services-cloud/components/process-filters-cloud.component.md
View File

@@ -32,10 +32,10 @@ Lists all available process filters and allows to select a filter.
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `any` | Emitted when any error occurs while loading the filters |
| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
| success | `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 |
| filterClicked | [`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 being clicked from the UI. |
| filterSelected | [`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 being selected based on the filterParam input. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when filters are loaded successfully |
## See also

8
docs/process-services-cloud/components/process-list-cloud.component.md
View File

@@ -75,17 +75,19 @@ when the process list is empty:
| startTo | `string` | "" | Filter the processes. Display only process with startedDate less than the supplied date. |
| status | `string` | "" | Filter the processes to display only the ones with this status. |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. |
| suspendedFrom | `string` | "" | Filter the processes. Display only process with suspendedFrom equal to the supplied date. |
| suspendedTo | `string` | "" | Filter the processes. Display only process with suspendedTo equal to the supplied date. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
| executeRowAction | `any` | Emitted when the user executes a row action. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected. |
| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
## Details

6
docs/process-services-cloud/components/start-process-cloud.component.md
View File

@@ -48,11 +48,11 @@ Starts a process.
| Name | Type | Description |
| ---- | ---- | ----------- |
| cancel | `any` | Emitted when the starting process is cancelled |
| error | `any` | Emitted when an error occurs. |
| 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. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. |
| success | `any` | Emitted when the process is successfully started. |
| 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

6
docs/process-services-cloud/components/task-filters-cloud.component.md
View File

@@ -42,9 +42,9 @@ Shows all available filters.
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
| filterClicked | [`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 is being clicked from the UI. |
| filterCounterUpdated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` | Emitted when filter counters are updated. |
| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
| filterSelected | [`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 is being selected based on the filterParam input. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
## Details
@@ -71,7 +71,7 @@ as the value of `filterParam` as shown in the table below:
### Showing Filter Counters
By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [TaskFilterCloudModel](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts).
By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts).
![](../../docassets/images/task-filter-counter.png)

14
docs/process-services-cloud/components/task-form-cloud.component.md
View File

@@ -48,14 +48,14 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar
| Name | Type | Description |
| ---- | ---- | ----------- |
| cancelClick | `any` | Emitted when the cancel button is clicked. |
| error | `any` | Emitted when any error occurs. |
| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the cancel button is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formSaved | `any` | Emitted when the form is saved. |
| taskClaimed | `any` | Emitted when the task is claimed. |
| taskCompleted | `any` | Emitted when the task is completed. |
| taskUnclaimed | `any` | Emitted when the task is unclaimed. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. |
| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is claimed. |
| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is completed. |
| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is unclaimed. |
## See also

6
docs/process-services-cloud/components/task-list-cloud.component.md
View File

@@ -90,11 +90,11 @@ when the task list is empty:
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| executeRowAction | `any` | Emitted when the user executes a row action. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected |
| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task list is loaded |
## Details

4
docs/process-services-cloud/services/process-filter-cloud.service.md
View File

@@ -47,8 +47,8 @@ Manage Process Filters, which are pre-configured Process Instance queries.
- _value:_ `Object` -
- _filterProperties:_ `string[]` -
- _appName:_ `string` - (Optional)
- _id:_ `string` - (Optional)
- _appName:_ `string` - (Optional) (Optional)
- _id:_ `string` - (Optional) (Optional)
- **Returns** `Object` -
## Inject Preference service