Element Details: Analysis Grid
 Back


Available in: Logi Info Source code name: AnalysisGrid

The Analysis Grid is a data table with a number of menu options that allow the user to flexibly interact with the data. The user may:

* Filter the data based on column values.
* Group data rows that have common values.
* Aggregate columns at the report and group levels.
* Create new columns with user-entered formulas.
* Create charts.
* Create crosstab tables with Crosstab Comparison.
* Change table layout and paging.
* Export data to PDF, Excel and CSV formats.

With all these possibilities, it may be important for the user to be able to save these settings between sessions. You can create a Process Task with a Procedure.SaveAnalysisGrid. Load a saved Analysis Grid with the rdAgLoadSaved parameter:

rdAgLoadSaved=filename
(filename is the name of a saved Analysis Grid file.)

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

rdAgReset=True

To get fresh data from the database while keeping the user's settings, call the report with the rdAgRefreshData parameter:

rdAgRefreshData=True

It is important that the value of the ID attribute for the AnalysisGrid element be unique throughout the entire application. This is because Logi Info saves the last state of the AnalysisGrid in a user’s session information based on the value of the ID for the AnalysisGrid element. Consequently, if two different report definitions each contain an AnalysisGrid with the same ID value, the application will display the same AnalysisGrid for both reports.

AnalysisGrid 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 grid's built-in CSS file is rdTemplate\rdAnalysisGrid\rdAg10Style.css.

For the best performance when working with a large relational database, use DataLayer.ActiveSQL instead of DataLayer.SQL.

Element Group:Data Tables



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
AgFilterCaseSensitivity
Sensitive
Insensitive
DataSourceCollation
AgFilterCaseSensitivity specifies if Filters are case-sensitive, case-insensitive, or if they should obey default case sensitivity of the source. When "Insenstive", values are compared without regard to upper and lower case. When "Sensitive", case must match exactly. When "DataSourceCollation", case must match if the data source's column definition indicates a case sensitive collation. The default value is blank. In this case, the value is derived from the settings' General element's FilterCaseSensitivity attribute.
AjaxPaging
True
False
Enables AJAX-style paging and sorting. When the user moves to another page, or sorts a column, only the table portion of the page is updated. This method prevents the web page from flickering or losing the scroll position. This alters the behavior of the browser's "Back" button because the page history does not get updated with AJAX Paging. The default value is "False".
AltRowClass
UserDefined
A style sheet class that will be used for every other row of the table. When using in an Analysis Grid define the class as follows in your stylesheet file: TR.[Classname] TD This ensures that your class is not overriden by an AnalysisGrid class. The themes class ThemeAlternatingRow takes care of this for you.
BatchSelection
True
False
When "True", BatchSelection allows the user to select a number of chart or table options and then click an "Update" or "OK" button to refresh the page. Normally, when False, the charts and tables are updated as the user makes individual choices. Setting BatchSelection="True" can speed the user interface by reducing the number of updates to the server.
Caption
UserDefined
The Caption attribute identifies the text to be displayed. For Image elements, Caption specifies the image filename.
Class
UserDefined
Sets the Cascading Style Sheet class used by the element. When set, this class will also be used by all child elements that don't have their own class. The class should be defined in the report's style sheet file.
CurrentPageClass
UserDefined
Sets the class for the "current" page number.
DisableReplaceConfirmation
True
False
When "True", disables the confirmation popup prompts that appear when replacing Formula Columns, Filters and Sort Orders.
DisableShowAllRows
True
False
This attribute prevents appearance of the AnalysisGrid's end-user feature to show all rows.
DraggablePanels
True
False
Specifies if the panels are draggable. This mode allows analysis grid panels to be placed wherever in the column desired by the user. When disabled, the panels are fixed to their locations. The default value is True.
ExcludeDetailRowsDefault
True
False
Users may group rows within the AnalysisGrid table. Normally, detail rows are included. In the table's configuration panel, a checkbox allows excluding detail rows. Setting this attribute to "True" causes detail rows to be initially hidden. In some cases, especially when working with very large databases, performance is better without detail rows. The default is "False".
HideAgAggr
True
False
Hide the "Aggregate" panel so that it is not available to the user.
HideAgCalc
True
False
Hide the "Formula" panel so that it is not available to the user.
HideAgChart
True
False
Hide the "Chart" panel so that it is not available to the user.
HideAgCrosstab
True
False
Hide the "Crosstab" panel so that it is not available to the user.
HideAgExport
True
False
Hide the "Export" links so that the user does not have export links available.
HideAgFilter
True
False
Hide the "Filter" panel so that it is not available to the user.
HideAgFormat
True
False
Hide the "Format" column formatting options so they are not available to the user.
HideAgGroup
True
False
Hide the "Group" panel so that it is not available to the user.
HideAgLayout
True
False
Hide the layout ("Columns") panel so that it is not available to the user.
HideAgMenu
True
False
Hide the tab menu, preventing the user from working with any of the AnalysisGrid tabs.
HideAgPaging
True
False
Hide the "Paging" panel so that it is not available to the user. To hide the table paging controls, set the PageRowCount attribute to 0.
HideAgSortOrder
True
False
Hide the "Sort Order" panel so that it is not available to the user.
HideFunctionNamesDefault
True
False
When set to True this attribute turns off the description of the values in Group Summary Rows and Aggregates. Descriptors like Count, Sum and Average are suppressed. This is False by default.
ID
UserDefined
(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.
MaxRowsExport
UserDefined
When working with very large data sets, exports may not be practical. Limiting the number of rows for exports helps prevent running a request that will take too long. To reduce the number of rows and thus enable exports, users may add one or more filters. The default is 100,000. Use a special value '-1', if you want to allow exporting all the rows and have no max limit set.
NumberedPageCount
UserDefined
Sets how many page number links appear for Interactive Paging when the ShowPageNumber attribute is "Numbered". The default is 10.
PageRowCount
UserDefined
Indicates the number of rows for each page.
SavedAnalysisGridFolder
UserDefined
Users' Analysis Grid options may be saved with the Procedure.SaveAnalysisGrid element. The options are reloaded by passing the saved filename in the rdAgLoadSaved parameter. This Saved Analysis Grid Folder attribute sets the folder that contains the saved files.
SecurityRightID
UserDefined
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.
ShowPageNumber
True
Numbered
False
When "True", shows the page number as something like "Page 2 of 4". Also allows the user to type in a page number. When "Numbered", a number of links appears for each page. You can set the number of pages with the NumberedPageCount attribute. Use the CurrentPageClass attribute to make the current page number stand out.
SortArrows
True
False
Enables sort direction indicators (arrows) when the user clicks a column heading to sort a table. The default value is False
TemplateModifierFile
UserDefined
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.
Width
UserDefined
The width of the element.
WidthScale
px
%
The width scale of the element. Value can be "px" for pixels, or "%" for percentage of the available width.



PARENT ELEMENTS

Click element to drill down for more information.

Body
Column Cell
Division Fieldset Box HTML Tag


CHILD ELEMENTS

Click element to drill down for more information.

Active Query Builder
Analysis Grid Column
Auto Bookmark
Conditional Class
Crosstab Comparison
Custom Dashboard Panels
Data Forecast
Data Table Column
DataLayer.ActiveSQL
DataLayer.Cached
DataLayer.CSV
DataLayer.Definition List
DataLayer.Directory
DataLayer.Excel
DataLayer.Fixed Format File
DataLayer.Google App
DataLayer.Google Spreadsheet
DataLayer.JSON
DataLayer.LDAP
DataLayer.Linked
DataLayer.Mongo Find
DataLayer.Mongo Map Reduce
DataLayer.Mongo Run Command
DataLayer.Plugin
DataLayer.REST
DataLayer.SP
DataLayer.SQL
DataLayer.Static
DataLayer.Twitter
DataLayer.Web Feed
DataLayer.Web Scraper
DataLayer.Web Service
DataLayer.XML
Generated Element Plugin Call
More Info Row
Wait Panel


 Back to top