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

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-06-07

Task Filters component

Shows all available filters.

Contents

• Basic Usage
• Class members
  • Properties
  • Events
• Details
  • Filtering APS task filters
  • How to create an accordion menu with the task filter
• See also

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	true	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.

How to create an accordion menu with the task filter

The task filter often works well as an item in an accordion menu. See the Accordion component page for an example of how to set this up.

See also

• Filter model