import AdvancedFilter from 'flexicious-react-datagrid/js/flexgrid/grids/filters/AdvancedFilter.js'
AdvancedFilter
Extends:
A container object that encapsulates all the individual property filter settings, page settings and the sort state.
Static Method Summary
Static Public Methods | ||
public static |
from(param: flexiciousNmsp.Filter): flexiciousNmsp.AdvancedFilter |
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public |
level: * |
|
public |
parentObject: * |
Method Summary
Public Methods | ||
public |
getClassNames(): string[] |
|
public |
getLevel(): flexiciousNmsp.FlexDataGridColumnLevel |
Inherited Summary
From class TypedObject | ||
public |
typeCache: {} |
|
public |
|
|
public |
Returns a list of strings that represent the object hierarchy for this object. |
|
public |
implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class. |
From class Filter | ||
public |
For the filter dropdown, show the label for the pre built filters. |
|
public |
A collection of com.flexicious.grids.filters.FilterExpression objects. |
|
public |
The number of pages |
|
public |
The current page index. |
|
public |
Size of the page |
|
public |
The total number of records |
|
public |
List of records |
|
public |
A collection of com.flexicious.grids.filters.FilterSort objects. |
|
public |
addCriteria(columnName: String, expression: Object) Adds a FilterExpression to the current list Uses the default equality operator. |
|
public |
addFilterExpression(filterExpression: flexiciousNmsp.FilterExpression) Expression to add |
|
public |
addOperatorCriteria(columnName: String, operation: String, compareValue: Object, wasContains: Boolean) Adds a com.flexicious.grids.filters.FilterExpression to the current list. |
|
public |
addSort(sortColumn: String, isAscending: Boolean, sortComparisionType: String, sortCompareFunction: Function) Adds a com.flexicious.grids.filters.FilterSort object to the list. |
|
public |
Takes a filter and populates the current filter's properties with the provided filter |
|
public |
getClassNames(): string[] |
|
public |
getFilterExpression(fld: String): * Given a filter column, returns the corresponding filter expression. |
|
public |
|
|
public |
getFilterValue(fld: String): * Given a filter column, returns the corresponding value of the filter expression of that column. |
|
public |
removeCriteria(searchField: String) Removes a previously added FilterExpression from the current list that matches the specified search field. |
|
public |
setFilterExpressions(val: *): * |
Static Public Methods
public static from(param: flexiciousNmsp.Filter): flexiciousNmsp.AdvancedFilter source
Params:
Name | Type | Attribute | Description |
param | flexiciousNmsp.Filter |
Return:
flexiciousNmsp.AdvancedFilter |
Public Constructors
Public Methods
public getClassNames(): string[] source
Returns a list of strings that represent the object hierarchy for this object.
Override:
Filter#getClassNamespublic getLevel(): flexiciousNmsp.FlexDataGridColumnLevel source
Return:
flexiciousNmsp.FlexDataGridColumnLevel | returns level |