Return to Builder Network Home
Application Development FrameworkADF DocumentationProcess Services APIComponentsTask 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. |
| filterClicked | EventEmitter<FilterRepresentationModel> | Emitted when a filter is being clicked from the UI. |
| filterSelected | EventEmitter<FilterRepresentationModel> | Emitted when a filter is being selected based on the filterParam input. |
| 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. |
© 2023 Alfresco Software, Inc. All Rights Reserved.
We use cookies on this site to enhance your user experience
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.