Element Details: Analysis+Filter

Available in: Logi Info Source code name: AnalysisFilterIntroduced in: 12.2.116

The Analysis Filter provides an easy user interface for creating filters to be applied to DataLayers.

The user may:
* Pick data columns from drop-down lists.
* Pick the type of comparison.
* Select from lists of data values.
* Add any number of column filters. These may be "ANDed" and "ORed". Parenthesis can be used to set the order of operations.

The columns which may be filtered are defined with child AnalysisFilterColumn elements.

AnalysisFilter requires a corresponding AnalysisFilterInsert element which goes under a DataLayer. Once a user sets a filter, the AnalysisFilterInsert is replaced by an automatically generated ConditionFilter, or SqlConditionFilter for DataLayer.ActiveSQL.

AnalysisFilter has two views. Design view offers full control for designing a filter. The Simple view is limited, allowing the user to just turn off individual filters and change values. The Design view appears for new filters, the simple view appears when restoring a filter from the SaveFile. Unless disabled, the user may switch between views.

Users' settings are automatically maintained during the session. Clear the settings by calling the report with the rdAfReset parameter:

You can save customizations for each user from session to session. See the SaveFile attribute for more details. When the AnalysisFilter is under a Dashboard, the SaveFile defaults to the Dashboard's SaveFile.

By default, the page is refreshed each time a filter is added or changed. But when RefreshElementIDs are specified, AnalysisFilter works in AJAX mode, updating only the specified elements.

For page refreshes, it is typically necessary to send and resend customized parameters. These may be passed using the LinkParams element. Also, RequestForwarding is on by default. It can be disabled by setting RequestForwarding="False".

AnalysisFilter defines certain Cascading Style Sheet (CSS) classes. These help with colors, font sizes and spacing. You can over-ride these classes by adding them to your own CSS file. The Analysis Filter's classes are defined in rdAnalysisGrid/rdAg10Style.css.

A filter may be added by passing parameter values into the report. In this example, parameters are setting Analysis Filter value and filter the element where Analysis Filter is applied.

<AnalysisFilter AnalysisFilterMode="Simple" CaseSensitivity="Insensitive" ID="myFilter" RefreshElementIDs="BarChartCanvas1">
<AnalysisFilterColumn DataColumn="CustomerID" DataType="Text" Format="" Header="Customer ID" ID="afcCustomerID" PopupValuesForFilter="List" />

<Label Caption="Filter">
<Action Type="RefreshElement" ElementID="myFilteredElement, myFilter" ID="ActionRefresh">
rdAfMode_myFilter="Simple" />


Click attribute Name to drill down for more information.

NamePossible ValuesDescription
Set CaseSensitive to "False" when comparing and matching values regardless of character case. For elements using DataLayer.ActiveSQL, CaseSensitive may be set to "DataSourceCollation". Then case sensitivity is defined by the database column's "collation" which may be sensitive or not. This option can provide better performance for case-insensitive filters. For AnalysisFilter with DataLayer.ActiveSQL and SqlCompareFilter, the default is "DataSourceCollation". The default is "True" for all other elements.
Disabling Design view causes the AnalysisFilter to appear only in the Simple view. The Design view gives the user full control of filter creation and updates. The Simple view is easier and limited, allowing the user to only remove filters with a checkbox. Normally, a report run without an AnalysisFilter SaveFile initially appears in Design view. When redisplayed, the report's AnalysisFilter appears with the Simple view. The default is "False".
Disabling Simple view causes the AnalysisFilter to appear only in the Design view. The Design view gives the user full control of filter creation and updates. The Simple view is easier and limited, allowing the user to only remove filters with a checkbox. Normally, a report run without an AnalysisFilter SaveFile initially appears in Design view. When redisplayed, the report's AnalysisFilter appears with the Simple view. The default is "False".
FilterCaptionElementID enables a one-line description of the filter to be displayed with the report. Create a Label element with an ID attribute. Leave the caption empty. Set the FilterCaptionElementID to the ID of this Label element. The Label's caption will get set with the filter's description/caption. The caption will appear like this: [myColumn1] = 'myValue', [myColumn2] = 'myColumn2Value'
The list of added filters can be positioned either below the input controls or to the right. The default is "Bottom".
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
NoFiltersSimpleCaption specifies the text to be displayed for the Simple View when there are no filters added.
RefreshElementIDs specifies a list of elements to be refreshed within the page, AJAX-style, when the current element is updated. When blank, the full page gets updated/reloaded.
Pass all request parameters to the next page. Note that request parameters cannot be forwarded if there is an Input element with the same name, because this would result in two values getting passed with the same name. Values from DefaultRequestValues elements are not forwarded. Unless otherwise noted, the default is "False".
Specifies a file to save the end-user's changes for the current element. When the element is reloaded it is shown in the same state as when it was last used. The file will be created if it does not exist. The containing folder is not automatically created. Ensure that the ASPNET process (Process Identity) has "write" access rights to the folder. To have a different save file for each user, include the @Function.UserName~ token in part of the filename. c:\myWeb\SavedFolder\@Function.UserName~.xml It's often useful to specify the folder in the Constants element in the settings definition file. @Constants.SaveFolder~\@Function.UserName~.xml Do not set the SaveFile when using an AutoBookmark element.
Specifies a file used as the initial SaveFile in cases when the SaveFile does not exist yet. For example, when the SaveFile is different for each user, SaveFileStarter can include a set of default Tabs and Panels. To create a SaveFileStarter, first set a SaveFile. Then run the element, making the desired changes. Finally, copy or rename the SaveFile into the SaveFileStarter location.
When entered, access to this element can be controlled with Logi security. Supply the ID of a right defined in the applications settings’ Security element. Only users that have a right in the SecurityRightID will be able to see the element. Note that when rights come from RightFromRole elements under Security/UserRights, and this element's SecurityRightID does NOT match any of the Right IDs defined in the Settings definition, then the user DOES have access. But when Right IDs are instead derived from RightsFromDataLayer or RightsFromRoles elements, and the user DOES NOT have a matching Right, then the user DOES NOT have access. You can enter multiple right IDs, separated by commas. In this case, the user sees the element if he has any one of the Rights.
Some elements employ a definition file as a template. The definition contains language and culture specific Caption attributes that you may want to change. Or you may simply want to change the captions to better suit your application. The TemplateModifierFile is an XML file with elements pointing to other elements in the template to be changed. All other attributes get applied in the template. For example, the Dashboard2 element has a template file (rdTemplate\rdDashboard\rdDashboard2Template.lgx) several Label elements. One has an ID="lblAddPanelsTitle". The Caption can be changed with the following XML in the TemplateModifierFile: You can set attributes for any number of elements. Examine the template file to learn the ID and Caption attributes you may want to modify. The above example shows how to identify template elements with an ID attribute. Alternatively, you can also identify elements with an XPath expression. In this example, we change an attribute of the InteractivePaging element: For a more detailed list of modifier actions see the following DevNet article. TemplateModifierFiles can be in any folder accessable to the web application. When a directory location is not specified, the default location is the _SupportFiles folder.


Click element to drill down for more information.

Column Cell
Fieldset Box
Panel Parameters
Popup Panel
Tab Panel


Click element to drill down for more information.

Analysis Filter Column Link Parameters Wait Panel

 Back to top