mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Updated doc comments (#4237)
This commit is contained in:
committed by
Eugenio Romano
parent
abb7692476
commit
267a87f110
@@ -11,6 +11,17 @@ Shows Process Filter Details.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Basic Usage](#basic-usage)
|
||||||
|
- [Class members](#class-members)
|
||||||
|
- [Properties](#properties)
|
||||||
|
- [Events](#events)
|
||||||
|
- [Details](#details)
|
||||||
|
- [Editing APS2 process filters](#editing-aps2-process-filters)
|
||||||
|
- [Filter properties](#filter-properties)
|
||||||
|
- [See also](#see-also)
|
||||||
|
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
```html
|
```html
|
||||||
@@ -29,11 +40,11 @@ Shows Process Filter Details.
|
|||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| appName | `string` | | (required) The name of the application. |
|
| appName | `string` | | The name of the application. |
|
||||||
| id | `string` | | (required) Id of the process instance filter. |
|
| filterProperties | `string[]` | | List of process filter properties to display |
|
||||||
| filterProperties | `string []` | `['state', 'sort', 'order']` | List of process filter properties to display. |
|
| id | `string` | | Id of the process instance filter. |
|
||||||
| showFilterActions | `boolean` | `true` | Toggles edit process filter actions. |
|
| showFilterActions | `boolean` | true | Toggles editing of process filter actions. |
|
||||||
| showTitle | `boolean` | `true` | Toggles edit process filter title. |
|
| showTitle | `boolean` | true | Toggles editing of the process filter title. |
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
@@ -57,12 +68,12 @@ Use the `appName` and `id` properties to choose which process filter to edit:
|
|||||||
|
|
||||||
### Filter properties
|
### Filter properties
|
||||||
|
|
||||||
You can supply various *filter properties* to edit that will determine
|
You can supply various _filter properties_ to edit that will determine
|
||||||
which processes are found by a filter. The full set of properties is
|
which processes are found by a filter. The full set of properties is
|
||||||
given below:
|
given below:
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| -- | -- |
|
| ---- | ----------- |
|
||||||
| **_appName_** | Name of the app |
|
| **_appName_** | Name of the app |
|
||||||
| **_initiator_** | ID of the user who initiated the process |
|
| **_initiator_** | ID of the user who initiated the process |
|
||||||
| **_state_** | Execution state of the process. |
|
| **_state_** | Execution state of the process. |
|
||||||
@@ -73,8 +84,8 @@ given below:
|
|||||||
| **_processInstanceId_** | Process instance ID |
|
| **_processInstanceId_** | Process instance ID |
|
||||||
| **_startDate_** | Date the process was started |
|
| **_startDate_** | Date the process was started |
|
||||||
| **_lastModified_** | Date the process was last modified |
|
| **_lastModified_** | Date the process was last modified |
|
||||||
| **_lastModifiedFrom_** | Finds processes modified *after* this date |
|
| **_lastModifiedFrom_** | Finds processes modified _after_ this date |
|
||||||
| **_lastModifiedTo_** | Finds processes modified *before* this date |
|
| **_lastModifiedTo_** | Finds processes modified _before_ this date |
|
||||||
|
|
||||||
By default, the **_state_**, **_sort_** and **_order_** properties are
|
By default, the **_state_**, **_sort_** and **_order_** properties are
|
||||||
displayed in the editor. However, you can also choose which properties
|
displayed in the editor. However, you can also choose which properties
|
||||||
@@ -109,4 +120,4 @@ to choose from: **_id_**, **_name_**, **_status_** and **_startDate_**.
|
|||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Edit task filter cloud component](edit-task-filter-cloud.component.md)
|
- [Edit task filter cloud component](edit-task-filter-cloud.component.md)
|
||||||
|
@@ -32,7 +32,7 @@ export class LoginDialogService {
|
|||||||
/**
|
/**
|
||||||
* Opens a dialog to choose a file to upload.
|
* Opens a dialog to choose a file to upload.
|
||||||
* @param action Name of the action to show in the title
|
* @param action Name of the action to show in the title
|
||||||
* @param contentEntry Item to upload
|
* @param title Title for the dialog
|
||||||
* @returns Information about the chosen file(s)
|
* @returns Information about the chosen file(s)
|
||||||
*/
|
*/
|
||||||
openLogin(actionName: string, title: string): Observable<string> {
|
openLogin(actionName: string, title: string): Observable<string> {
|
||||||
|
@@ -55,9 +55,11 @@ export class EditProcessFilterCloudComponent implements OnChanges {
|
|||||||
@Input()
|
@Input()
|
||||||
filterProperties: string[] = EditProcessFilterCloudComponent.DEFAULT_PROCESS_FILTER_PROPERTIES; // default ['state', 'sort', 'order']
|
filterProperties: string[] = EditProcessFilterCloudComponent.DEFAULT_PROCESS_FILTER_PROPERTIES; // default ['state', 'sort', 'order']
|
||||||
|
|
||||||
|
/** Toggles editing of process filter actions. */
|
||||||
@Input()
|
@Input()
|
||||||
showFilterActions = true;
|
showFilterActions = true;
|
||||||
|
|
||||||
|
/** Toggles editing of the process filter title. */
|
||||||
@Input()
|
@Input()
|
||||||
showTitle = true;
|
showTitle = true;
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user