EaxMdService.setDimDataFilter

Syntax

setDimDataFilter(report: PP.Exp.EaxAnalyzer, dFilter: Object, callback: PP.Delegate);

Parameters

report. Express report, for highlighting elements of which the filter is defined.

dFilter. Filter options: JSON object that contains the properties min (minimum value) and max (maximum value). If the options are not specified, the elements are highlighted in accordance with data set in the Highlight Between Values value editors in the Data tab of properties panel.

callback. Callback function.

Description

The setDimDataFilter method sets a filter for elements of express report highlighting.

Example

Executing the example requires that the page contains the ExpressBox component named expressBox and a service for working with express report named eaxMdService (see Example of Creating the ExpressBox Component). Set a filter for elements of express report highlighting:

eaxMdService.setDimDataFilter(expressBox.getSource().getActiveSheet(), {
   min: 1,
   max: 10
}, function (sender, args) {
   console.log("Dimension elements are highlighted")
});

After executing the example dimension elements that contain values 1 to 10 are highlighted in the Selection tab of the properties panel:

The browser console displays the following message: Dimension elements are highlighted.

Then hide all non-highlighted elements in the open panel:

propBar = expressBox.getPropertyBarView();
propBar.getDimBarMasterView();
dimBarM = propBar.getDimBarMasterView();
dimBarMP = dimBarM.getActivePanel();
dtv = dimBarMP.getDimTreeView();
dtv.setHideShadedEls(true);

All non-highlighted elements in the open panel will be hidden:

Set highlighting for dimension element with the 1 key:

dimSel = new PP.Mb.DimSelection({
    Dimension: dimBarMP.getSource()
});
dimSel.selectElement(1);

The panel displays dimension element with the 1 key, other elements are hidden (because the DimTreeView.HideShadedEls property was earlier set to True).