FilterEls: Object
The FilterEls property contains an object with element filter parameters.
Use JSON or the setFilterEls method to set the property value and the getFilterEls method to get the property value.
Parameters of the setFilterEls method:
- dimFilter. Object that contains filter parameters.
- els. Array of elements filtered with the filter with specified parameters.
Parameters of the getFilterEls method:
- dimFilter. Filter parameters, an instance of the PP.Mb.DimFilter class.
To execute the example, the HTML page must contain the DimensionTree component named dimTree (see Example of Creating the DimensionTree Component). Set and filter dimension elements:
function filterElements(dim, filter) {
var result = [];
var elems = dim.getFilterEls(filter);
for (var i in elems) {
var elem = elems[i];
if (filter && filter.getType() === "Contains" && (elem.indexOf(filter.getValue()) >= 0)) {
result.push(elem);
}
}
return result;
};
//Get dimension source
dim = dimTree.getSource();
//Set filter parameters
var filter = new PP.Mb.DimFilter({
Value: "4",
Type: "Contains",
Attr: "NAME",
CaseSensitive: False
});
//Specify parameters of filter for dimension elements
dim.setFilterEls(filter, ["YEARS:2002", "YEARS:2003", "YEARS:2004"]);
console.log("Source elements: %s", dim.getFilterEls(filter).toString());
//Output keys of elements, for which filter parameters are specified, to the console
var result = filterElements(dim, filter);
console.log("Filtered elements: %s", result.toString());
After the executing the example the elements YEARS:2002, YEARS:2003, YEARS:2004 are set, for which those that contain the 3 element are filtered:
Source elements: YEARS:2002,YEARS:2003,YEARS:2004
Filtered elements: YEARS:2004
Clear set filters for all elements:
dim.clearFilterCache();
As a result filter parameters are cleared for all elements.
See also: