ElsTree.TextFilter

Syntax

TextFilter: Object;

Description

The TextFilter property sets text filter applied to tree elements.

Comments

Text filter in the interface is set via the search string.

Property value can be set from JSON and using the setTextFilter(text, attributes, caseSensitive, wholeWordsOnly) method, where:

text. Search string.
attributes. Array of attributes' identifiers, by which search is performed.
caseSensitive. Match case.
wholeWordsOnly. Match whole words.

Property value is returned by the getTextFilter() method.

Example

To execute the example, the HTML page must contain the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). A calendar dimension tab must be selected on the side panel, set text filter for dimension:

// Get side panel
PropBar = expressBox.getPropertyBarView();
// Get side panel control
Control = PropBar.getControl();
// Get side panel tab
Panel = Control.getActiveItem();
// Get view of dimension element tree
TreeV = Panel.getDimTreeView();
// Load tree elements
TreeV.loadFirst();
// Set text filter
TreeV.setTextFilter("2000", ["NAME"], false, false);

After executing the example the filter by the 2000 element is applied to the displayed dimension on the side panel.