mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
[ADF-2847] Added class members headings to proces and insights docs (#3263)
This commit is contained in:
parent
513915b3d9
commit
96fddbdc39
@ -15,6 +15,8 @@ Generates and shows charts
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -14,6 +14,8 @@ Shows a list of all available reports
|
||||
</analytics-report-list>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -17,6 +17,8 @@ Shows the charts related to the reportId passed as input
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -24,6 +24,8 @@ The below component shows the diagram of a running process instance with the act
|
||||
</adf-diagram>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
|
@ -29,6 +29,8 @@ If we intend to show a custom template if there are no apps present
|
||||
</adf-apps>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -16,6 +16,8 @@ Shows the checklist task functionality.
|
||||
</adf-checklist>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
|
||||
</adf-create-process-attachment>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
|
||||
</adf-create-task-attachment>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
|
@ -71,6 +71,8 @@ In the component template use the people list component:
|
||||
Note that the people list component is based on the
|
||||
[Datatable component](../core/datatable.component.md).
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -12,6 +12,8 @@ Searches users/people.
|
||||
<adf-people-search></adf-people-search>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -6,6 +6,8 @@ Status: Active
|
||||
|
||||
Displays users involved with a specified task
|
||||
|
||||

|
||||
|
||||
## Contents
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
@ -30,7 +32,7 @@ Displays users involved with a specified task
|
||||
</adf-people>
|
||||
```
|
||||
|
||||

|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
|
@ -36,6 +36,8 @@ export class MyCustomProcessAttachmentComponent {
|
||||
}
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -14,6 +14,8 @@ Displays comments associated with a particular process instance and allows the u
|
||||
</adf-process-instance-comments>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -8,7 +8,9 @@ Last reviewed: 2018-03-21
|
||||
|
||||
Manage Process Filters, which are pre-configured Process Instance queries.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `getProcessFilters(appId: number): Observable<FilterProcessRepresentationModel[]>`
|
||||
Gets all filters defined for a Process App.
|
||||
|
@ -14,6 +14,8 @@ Collection of criteria used to filter process instances, which may be customized
|
||||
</adf-process-instance-filters>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -14,6 +14,8 @@ Displays detailed information on a specified process instance
|
||||
</adf-process-instance-details>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -16,6 +16,8 @@ Sub-component of the process details component, which renders some general infor
|
||||
</adf-process-instance-details>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -15,6 +15,8 @@ Lists both the active and completed tasks associated with a particular process i
|
||||
</adf-process-instance-tasks>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -19,6 +19,8 @@ Renders a list containing all the process instances matched by the parameters sp
|
||||
</adf-process-instance-list>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|
@ -8,7 +8,9 @@ Last reviewed: 2018-03-20
|
||||
|
||||
Manages Process Instances, Process Variables, and Process Audit Log.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `getProcessInstances(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel>`
|
||||
Get process instances for a filter and optionally a process definition.
|
||||
|
@ -18,6 +18,8 @@ Starts a process.
|
||||
</adf-start-process>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
|
@ -16,6 +16,8 @@ Creates/Starts new task for the specified app
|
||||
</adf-start-task>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -18,6 +18,8 @@ Displays attached documents on a specified task.
|
||||
</adf-task-attachment-list>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -16,6 +16,8 @@ Shows the details of the task ID passed in as input.
|
||||
</adf-task-details>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -7,7 +7,9 @@ Status: Active
|
||||
|
||||
Manage Task Filters, which are pre-configured Task Instance queries.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `createDefaultFilters(appId: number): Observable<FilterRepresentationModel[]>`
|
||||
Creates and returns the default filters for a process app.
|
||||
|
@ -12,6 +12,8 @@ Shows all available filters.
|
||||
<adf-filters></adf-filters>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -18,6 +18,8 @@ Shows all the information related to a task.
|
||||
</adf-task-header>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -18,6 +18,8 @@ Renders a list containing all the tasks matched by the parameters specified.
|
||||
</adf-tasklist>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -20,6 +20,9 @@ This component can be used when there is no form attached to a task.
|
||||
[taskName]= "taskname">
|
||||
</adf-task-standalone>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|
@ -8,7 +8,9 @@ Last reviewed: 2018-03-22
|
||||
|
||||
Manages Task Instances.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel>`
|
||||
Gets all the filters in the list that belong to a task.
|
||||
|
Loading…
x
Reference in New Issue
Block a user