Skip to content

Latest commit

 

History

History
95 lines (69 loc) · 4.14 KB

task-filters-cloud.component.md

File metadata and controls

95 lines (69 loc) · 4.14 KB
Raw
Title Added Status Last reviewed
Task Filters Cloud component
v3.0.0
Experimental
2019-01-08

Task Filters Cloud component

Shows all available filters.

Contents

Basic Usage

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

Class members

Properties

Name Type Default value Description
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 cloud. If there is no match then the default filter (the first one in the list) is selected.
showIcons boolean false Toggles display of the filter's icons.

Events

Name Type Description
error EventEmitter<any> Emitted when an error occurs during loading.
filterClicked EventEmitter<TaskFilterCloudModel> Emitted when a filter is being clicked from the UI.
filterCounterUpdated EventEmitter<TaskCloudEngineEvent> Emitted when filter counters are updated.
filterSelected EventEmitter` Emitted when a filter is being selected based on the filterParam input.
success EventEmitter<any> Emitted when the list is loaded.

Details

Filtering APS2 task filters

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

<adf-cloud-task-filters
   [filterParam]="{name:'My tasks'}">
</adf-cloud-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
key string The key of the task filter
index string The zero-based position of the filter in the array

Showing Filter Counters

By default, filter counters are hidden. If you want to display filter counters you will need to add the showCounter property set to true in your TaskFilterCloudModel.

Updating Filter Counters

If you want to disable notification bubbles as task filters change you can change it directly from the app.config.json.

{
    ...
    "notifications": true
    ...
}

See also