Filter¶
A filter action can help users narrow down the items displayed in a collection control.
All the properties defined under Action are applicable to this action.
Supported only on ObjectTable, ObjectCollection, ContactCell, Data Table, Grid Table and ExtensionCollection
Filter Properties¶
Property | Type | Required | Default |
---|---|---|---|
Filterable | string |
No | |
ModalPageFullscreen | boolean |
No | false |
PageToOpen | Page | No | |
_Type | const |
Yes |
Filterable¶
Targetpath to the filterable control.
- type:
string
ModalPageFullscreen¶
How to display the filter options modal page. By design on iPhone, a modal page appears only in fullscreen.
- type:
boolean
- default:
false
PageToOpen¶
The model filter options page.
- type: Page
_Type¶
- type:
const
The value of this property must be:
"Action.Type.Filter"
Action Result¶
Refer to the MDK Guide to understand what an action result is.
The success ActionResult of this action is a JS object containing the filter and sorter. The failure ActionResult is an error message.
Examples¶
// Filter.action
{
"_Type": "Action.Type.Filter",
"Filterable": "{#Page:SectionedTablePage/#Control:SectionedTable}",
"PageToOpen": "/ProjectName/Pages/Modal/FilterPage.page"
}