Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 5.38 KB

process-filters.component.md

File metadata and controls

77 lines (56 loc) · 5.38 KB
Title Added Status Last reviewed
Process Filters Component
v2.0.0
Active
2018-09-14

Process Filters Component

Collection of criteria used to filter process instances, which may be customized by users.

Contents

Basic Usage

<adf-process-instance-filters appId="1001">
</adf-process-instance-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 FilterProcessRepresentationModel The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected.
showIcon boolean true Toggle to show or hide the filter's icon.

Events

Name Type Description
error EventEmitter<any> Emitted when an error occurs.
filterClicked EventEmitter<UserProcessInstanceFilterRepresentation> Emitted when a filter is being clicked from the UI.
filterSelected EventEmitter<UserProcessInstanceFilterRepresentation> Emitted when a filter is being selected based on the filterParam input.
success EventEmitter<ProcessInstanceFilterRepresentation[]> Emitted when the list of filters has been successfully loaded from the server.

Details

This component displays a list of available filters and allows the user to select any given filter as the active filter.

The most common usage is in driving a process instance list to allow the user to choose which process instances are displayed in the list.

If both appId and appName are specified then appName will take precedence and appId will be ignored.

How filter the Activiti process filters

<adf-process-instance-filters 
   [filterParam]="{index: 0}">
</adf-process-instance-filters>

You can use inside the filterParam one of the properties defined by UserTaskFilterRepresentation:

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

See also