alfresco-ng2-components/docs/process-services/task-filters.component.md

2.1 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Task Filters component v2.0.0 Active 2018-11-16

Task Filters component

Shows all available filters.

Basic Usage

<adf-task-filters></adf-task-filters>

Class members

Properties

Name Type Default value Description
appId number Display filters available to the current user for the application with the specified ID.
appName string Display filters available to the current user for the application with the specified name.
filterParam FilterParamsModel Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected.
showIcon boolean Toggles display of the filter's icon.

Events

Name Type Description
error EventEmitter<any> Emitted when an error occurs during loading.
filterClick EventEmitter<FilterRepresentationModel> Emitted when a filter in the list is clicked.
success EventEmitter<any> Emitted when the list is loaded.

Details

Filtering APS task filters

Use the filterParam property to restrict the range of filters that are shown:

<adf-task-filters 
   [filterParam]="{name:'My tasks'}">
</adf-task-filters>

You can use properties from FilterParamsModel as the value of filterParam as shown in the table below:

Name Type Description
id string The id of the task filter
name string The name of the task filter, lowercase is checked
index string The zero-based position of the filter in the array.