The Filter object defines the single instance of the filters collection property used in the Table Object schema.
Two instance types for the Filter object are used internally.
The first, the static object definition, refers to the static Javascript definition.
The second, refers to a Javascript Filter object which is created as part of the static Table Object migration process.
This instance allows the HTML code to directly access methods defined
for the Filter object.
The migration process copies all of the static properties to the dynamic version.
The Filter object definition is found in the filters property of the Table Object oTabProp object.
That is the filters property is an array of one or more Filter object definitions. Each definition has one or more of the following properties. Some property
specifications depend on the type value.
Note that the order the filters in this definition is the order they appear in both the List Controller Filter panel and, with the exception of the 'limit' type the order that the record selection cascades the results to the next filter (there is no 'OR' capability). The 'limit' filter is applied last and limits the result set to no more than the specified number.
If no type 'limit' filter is defined in the filters array, one is inserted with a default value of '50'.
type:This
property defines the type of filter. The internal record selection routines use this type to alter their logic. The possible value are:
'cust' The methCust property references a method that will be called.
'mask' The default string mask search against the field is used. If uses standard Regular Expression syntax to match against the contents of the field
for each record still in the selection set.
'chkbox' A binary checkbox value. The methCust property should reference a method that will be called.
'state' A tri-state input filter not fuilly implemented.
'limit' The input field specifies the maximum number of rows that will be displayed.
place:Used with type 'cust' and 'mask' to specify a placeholder string.
title:Used to provide a label for the filter and shown in the Filter Panel.
methCust:The reference to a local function called by a type 'cust' filter.
The signature of the call is func-name(oTab,oObjs,oData,oFil) where
oTab is the dynamic Table Object, oObjs is the cascaded array of Data Objects,
oData is the oSel work area and in which cached results can be stored and oFil is the present Filter object.
field:Defines the related table field that the mask works against. For type 'cust' and 'chkbox' it can define an internal scope property stored in $scope.oSel
that can be used to store intermediate of cached values.