diff --git a/docs/insights/analytics-generator.component.md b/docs/insights/analytics-generator.component.md index 3ee619f960..655bff8bd8 100644 --- a/docs/insights/analytics-generator.component.md +++ b/docs/insights/analytics-generator.component.md @@ -15,6 +15,8 @@ Generates and shows charts ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/insights/analytics-report-list.component.md b/docs/insights/analytics-report-list.component.md index 127cf96e4c..9f01f9d3c2 100644 --- a/docs/insights/analytics-report-list.component.md +++ b/docs/insights/analytics-report-list.component.md @@ -14,6 +14,8 @@ Shows a list of all available reports ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/insights/analytics.component.md b/docs/insights/analytics.component.md index 5007cd4ec6..2a07229ebc 100644 --- a/docs/insights/analytics.component.md +++ b/docs/insights/analytics.component.md @@ -17,6 +17,8 @@ Shows the charts related to the reportId passed as input ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/insights/diagram.component.md b/docs/insights/diagram.component.md index ca2f190370..c683e1f08b 100644 --- a/docs/insights/diagram.component.md +++ b/docs/insights/diagram.component.md @@ -24,6 +24,8 @@ The below component shows the diagram of a running process instance with the act ``` +## Class members + ### Properties | Name | Type | Description | diff --git a/docs/process-services/apps-list.component.md b/docs/process-services/apps-list.component.md index 5cc034dfcb..1b56ea37df 100644 --- a/docs/process-services/apps-list.component.md +++ b/docs/process-services/apps-list.component.md @@ -29,6 +29,8 @@ If we intend to show a custom template if there are no apps present ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/checklist.component.md b/docs/process-services/checklist.component.md index 7f52b375b4..61e0b0da94 100644 --- a/docs/process-services/checklist.component.md +++ b/docs/process-services/checklist.component.md @@ -16,6 +16,8 @@ Shows the checklist task functionality. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/create-process-attachment.component.md b/docs/process-services/create-process-attachment.component.md index 377f5b6400..eede0fb236 100644 --- a/docs/process-services/create-process-attachment.component.md +++ b/docs/process-services/create-process-attachment.component.md @@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/create-task-attachment.component.md b/docs/process-services/create-task-attachment.component.md index e8dc8826b4..e417e007c0 100644 --- a/docs/process-services/create-task-attachment.component.md +++ b/docs/process-services/create-task-attachment.component.md @@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi ``` +## Class members + ### Properties | Name | Type | Description | diff --git a/docs/process-services/people-list.component.md b/docs/process-services/people-list.component.md index 366fb9650b..6131c064eb 100644 --- a/docs/process-services/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -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 | diff --git a/docs/process-services/people-search.component.md b/docs/process-services/people-search.component.md index 86594f3dae..bdae321717 100644 --- a/docs/process-services/people-search.component.md +++ b/docs/process-services/people-search.component.md @@ -12,6 +12,8 @@ Searches users/people. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/people.component.md b/docs/process-services/people.component.md index 559cff40f5..fa547244f0 100644 --- a/docs/process-services/people.component.md +++ b/docs/process-services/people.component.md @@ -6,6 +6,8 @@ Status: Active Displays users involved with a specified task +![activiti-people](../docassets/images/activiti_people.png) + ## Contents - [Basic Usage](#basic-usage) @@ -30,7 +32,7 @@ Displays users involved with a specified task ``` -![activiti-people](../docassets/images/activiti_people.png) +## Class members ### Properties diff --git a/docs/process-services/process-attachment-list.component.md b/docs/process-services/process-attachment-list.component.md index 3df3f64d25..d145c373bc 100644 --- a/docs/process-services/process-attachment-list.component.md +++ b/docs/process-services/process-attachment-list.component.md @@ -36,6 +36,8 @@ export class MyCustomProcessAttachmentComponent { } ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-comments.component.md b/docs/process-services/process-comments.component.md index 4487ecd469..658bdbcf29 100644 --- a/docs/process-services/process-comments.component.md +++ b/docs/process-services/process-comments.component.md @@ -14,6 +14,8 @@ Displays comments associated with a particular process instance and allows the u ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-filter.service.md b/docs/process-services/process-filter.service.md index fbc7014da7..dd1aa91ec5 100644 --- a/docs/process-services/process-filter.service.md +++ b/docs/process-services/process-filter.service.md @@ -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` Gets all filters defined for a Process App. diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index 329d2af51a..06c3ce536e 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -14,6 +14,8 @@ Collection of criteria used to filter process instances, which may be customized ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-instance-details.component.md b/docs/process-services/process-instance-details.component.md index ea33838ff3..743412c1df 100644 --- a/docs/process-services/process-instance-details.component.md +++ b/docs/process-services/process-instance-details.component.md @@ -14,6 +14,8 @@ Displays detailed information on a specified process instance ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-instance-header.component.md b/docs/process-services/process-instance-header.component.md index 751bdb40c3..3e752d3507 100644 --- a/docs/process-services/process-instance-header.component.md +++ b/docs/process-services/process-instance-header.component.md @@ -16,6 +16,8 @@ Sub-component of the process details component, which renders some general infor ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-instance-tasks.component.md b/docs/process-services/process-instance-tasks.component.md index 93b2bea3ce..b90cf627dc 100644 --- a/docs/process-services/process-instance-tasks.component.md +++ b/docs/process-services/process-instance-tasks.component.md @@ -15,6 +15,8 @@ Lists both the active and completed tasks associated with a particular process i ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/process-list.component.md b/docs/process-services/process-list.component.md index 445a66455a..b75042a35b 100644 --- a/docs/process-services/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -19,6 +19,8 @@ Renders a list containing all the process instances matched by the parameters sp ``` +## Class members + ### Properties | Name | Type | Default | Description | diff --git a/docs/process-services/process.service.md b/docs/process-services/process.service.md index e13c2abee5..919dc5f99b 100644 --- a/docs/process-services/process.service.md +++ b/docs/process-services/process.service.md @@ -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` Get process instances for a filter and optionally a process definition. diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index 7886126680..c31d865f1a 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -18,6 +18,8 @@ Starts a process. ``` +## Class members + ### Properties | Name | Type | Description | diff --git a/docs/process-services/start-task.component.md b/docs/process-services/start-task.component.md index d3d85e4c3a..a4a019840e 100644 --- a/docs/process-services/start-task.component.md +++ b/docs/process-services/start-task.component.md @@ -16,6 +16,8 @@ Creates/Starts new task for the specified app ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-attachment-list.component.md b/docs/process-services/task-attachment-list.component.md index f1db8014ba..34a9b26814 100644 --- a/docs/process-services/task-attachment-list.component.md +++ b/docs/process-services/task-attachment-list.component.md @@ -18,6 +18,8 @@ Displays attached documents on a specified task. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-details.component.md b/docs/process-services/task-details.component.md index 69c8ddf4ec..63ea93c3e0 100644 --- a/docs/process-services/task-details.component.md +++ b/docs/process-services/task-details.component.md @@ -16,6 +16,8 @@ Shows the details of the task ID passed in as input. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-filter.service.md b/docs/process-services/task-filter.service.md index 75f1cc3a78..5369ea0d4b 100644 --- a/docs/process-services/task-filter.service.md +++ b/docs/process-services/task-filter.service.md @@ -7,7 +7,9 @@ Status: Active Manage Task Filters, which are pre-configured Task Instance queries. -## Methods +## Class members + +### Methods - `createDefaultFilters(appId: number): Observable` Creates and returns the default filters for a process app. diff --git a/docs/process-services/task-filters.component.md b/docs/process-services/task-filters.component.md index 4e1b157cca..88fff65602 100644 --- a/docs/process-services/task-filters.component.md +++ b/docs/process-services/task-filters.component.md @@ -12,6 +12,8 @@ Shows all available filters. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-header.component.md b/docs/process-services/task-header.component.md index cdc6adcf4e..b12f8ae077 100644 --- a/docs/process-services/task-header.component.md +++ b/docs/process-services/task-header.component.md @@ -18,6 +18,8 @@ Shows all the information related to a task. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-list.component.md b/docs/process-services/task-list.component.md index aac002089f..2a6ffe9eac 100644 --- a/docs/process-services/task-list.component.md +++ b/docs/process-services/task-list.component.md @@ -18,6 +18,8 @@ Renders a list containing all the tasks matched by the parameters specified. ``` +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/task-standalone.component.md b/docs/process-services/task-standalone.component.md index a550b63b2e..71396c68c8 100644 --- a/docs/process-services/task-standalone.component.md +++ b/docs/process-services/task-standalone.component.md @@ -20,6 +20,9 @@ This component can be used when there is no form attached to a task. [taskName]= "taskname"> ``` + +## Class members + ### Properties | Name | Type | Default value | Description | diff --git a/docs/process-services/tasklist.service.md b/docs/process-services/tasklist.service.md index 484ba93393..3d51600bad 100644 --- a/docs/process-services/tasklist.service.md +++ b/docs/process-services/tasklist.service.md @@ -8,7 +8,9 @@ Last reviewed: 2018-03-22 Manages Task Instances. -## Methods +## Class members + +### Methods - `getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable` Gets all the filters in the list that belong to a task.