Skip to content

Filter

A filter action can help users narrow down the items displayed in a collection control.

The properties defined in Action are also applicable to this action.

Supported only on ObjectTable, ObjectCollection, ContactCell, Data Table, Grid Table and ExtensionCollection

Filter Properties

Property Type Required Default
Filterable string Optional
ModalPageFullscreen boolean Optional false
PageToOpen Page Optional
_Type const Required

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

  • type: const

The value of this property must be equal to:

"Action.Type.Filter"

Action Result

The ActionResult of this action is a JS object containing the filter and sorter.


Examples

// Filter.action
{
    "_Type": "Action.Type.Filter",
    "Filterable": "{#Page:SectionedTablePage/#Control:SectionedTable}",
    "PageToOpen" : "/ProjectName/Pages/Modal/FilterPage.page"
}