Filter component

Level: beginner

Use the Filter component to filter data.

View the example of a configuration object that filters data below.

Example of a configuration object that filters data

{
    "type": "crt.RelatedDetailItem",
    "moduleName": "Activity",
    "relationOptions": {
        "detailColumn": "Opportunity",
        "masterColumn": "Id",
        "parentRecordId": "$Id"
    },
    "filterAttributes": [
        {
            "name": "ActivityDetail_Filter"
        }
    ],
    "caption": "Attachments",
    "parentModuleName": "Opportunity"
}

---

string type

Component type. crt.RelatedDetailItem for the Filter component.

---

string moduleName

The name of module that was customized in the manifest.

---

object relationOptions

Configuration object to create a related filter based on the parent model.

Parameters

Name	Description
string detailColumn	The child object.
string masterColumn	The parent object column that is linked to the child object.
string parentRecordId	The object column that is linked to the parent object.

---

array of objects filterAttributes

Additional filters.

Parameters

Name	Description
string name	The attribute that implements the filter from the viewModelConfig schema section.

---

string caption

Link name.

---

string parentModuleName

Name of the Classic UI form page.