element <filterExpression>
Namespace: |
http://schema.caplin.com/CaplinTrader/gridDefinitions |
XML Representation Summary |
||||||
| <filterExpression | ||||||
|
||||||
| > | ||||||
|
||||||
| </filterExpression> | ||||||
Child elements (3):
Parent elements (3):
Description
Contains a logical filter expression (as a combination of <fieldFilter>, <and>, and <or> tags)
that is applied to the grid row model. A filter expression allows you to restrict
the number of rows that are displayed in the grid. For example, the filter expression
"(BidSize >= 1000) AND (AskSize < 1015)" selects only those rows where the BidSize field has a value
of 1000 or more and the AskSize field has a value below 1015.
The <filterExpression> tag can only contain one direct child tag;
filter expressions containing multiple <fieldFilter> tags are defined by nesting the
<fieldFilter> tags within <and> and <or> tags. See the examples shown earlier in this document.
If a filter expression is defined in a parent <grid> or <gridTemplate>,
any grids that inherit from this parent also inherit the filter expression.
However, a filter expression that is defined in a child grid overrides filter
expressions of the same name defined in grids and grid templates that it inherits from.
The data provider that populates a grid with data can be an RTTP container;
that is, an instance of the JavaScript class 'caplin.grid.RttpContainerGridDataProvider'
defined in a <dataProviderMapping>. In this case, the filter expression is converted to a request
for a filtered RTTP container and is sent to Liberator. Liberator returns a container with the
filtered data in it to be displayed in the grid.
-
Type:xs:string, predefinedUse:optionalDefault:"default"This attribute is required if more than one <filterExpression> is defined in XML, and must uniquely identify the filter expression from all other filter expressions that you define. The name is not used in any XML configuration, but can be used in JavaScript code to identify the filter expression.