alfresco-ng2-components/docs/process-services-cloud/process-filter-cloud.component.md
Deepak Paul 1387aff0f4 [ADF-3749] Process Filter Component - APS2 (#3998)
* [ADF-3749] Created new process filter component

* [ADF-3749] Improved process filters

* [ADF-3749] Improved process filters

* [ADF-3749] Added tests

* [ADF-3749] Included filter in process list cloud demo

* [ADF-3749] Added documentation

* [ADF-3749] Improved documentation

* [ADF-3749] Added new query model and improved model names

* [][ADF-3749] Added extra documentation

* [ADF-3749] Added new key in the filter models

* [ADF-3749] Added translation support for filters

* [ADF-3749] Added new tests

* [ADF-3749] Added new translation keys
2018-11-27 21:14:48 +00:00

1.9 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v3.0.0 Active 2018-21-11

Process Filter Cloud Component

Lists all available process filters and allows to select a filter.

Contents

Basic Usage

<adf-cloud-process-filters
    [appName]="currentAppName"
    [showIcons]="true">
</adf-cloud-process-filters>

Class members

Properties

Name Type Default value Description
appName string (required) The application name
filterParam ProcessFilterParamModel (optional) The filter to be selected by default
showIcons boolean false (optional) The flag hides/shows icon against each filter

Events

Name Type Description
filterClick EventEmitter<ProcessFilterRepresentationModel> Emitted when a filter is selected/clicked.
success EventEmitter<any> Emitted when filters are loaded successfully.
error EventEmitter<any> Emitted when any error occurs while loading the filters.

Details

The filterParam input can be used to select a filter as mentioned below.

<adf-cloud-process-filters
    [filterParam]="{name:'Running Processes'}">
</adf-cloud-process-filters>

A filter can be selected by using any of the ProcessFilterParamModel property.

Name Type Description
id string The id of the filter
name string The name of the filter
key string The key of the filter
index string The zero-based position of the filter in the array