Data Grid Widget
Copyright © 2019 EarthSoft, Inc • Modified: 12 Nov 2019
The Data Grid widget displays the output of a grid report (i.e., IGridReport) in a sortable, filterable grid that supports paging. Since the visibility and order of report fields can be configured, this widget is useful for reviewing data without downloading the full report output. The Data Grid widget also supports filtering using filter widgets.
Note: The Data Grid widget will run the underlying report with each action (sort, filter, switch pages, change page size, etc.). EarthSoft highly recommends using report caching (see User Profile) when using the Data Grid report. Report caching will significantly reduce database load and improve the end user experience while using the widget.
When using the Chrome browser, individual cell selection in the data grid is functional. The data columns of the Data Grid widget can be sorted or filtered.
Sorting – The columns are sortable in ascending or descending order by clicking on the column header (click again to reverse the sort). The sort is applied to full report output (with filter, if applicable); it does not just apply to the currently visible page of the grid.
Filtering – Beneath each column header is a filter box that filters on that column only. Enter a search term (one or more characters) in the appropriate search box beneath the column header. Only records that contain the search term will be displayed. Filtering is cumulative if multiple columns are filtered.
Download – Click the Download button to download all pages of the grid data as a Microsoft Excel file (*.xlsx). The downloaded file will respect any active filter currently applied to the grid.
The bottom of the widget contains paging controls for displaying a limited number of items at a time, as described below.
Arrows – Use the left/right arrows to navigate through pages.
Go to Page List – Select a specific page to navigate directly to that page.
Rows per Page – Change the number of items to be displayed per page by using the drop-down menu.
Count of Pages and Total Items – This control indicates the total number of items available in the widget, how many pages to display the items, and which page is currently selected.
The Data Grid widget is empty when added to a dashboard and must be configured to show report results. The editor for this widget allows the user to select a report, and then use the columns from the report to configure the widget appearance. The columns that are displayed and their order are controlled by the widget properties.
To add a report or edit other widget properties, open the Widget Editor by selecting the More Options icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.
Widget Title – By default, the widget title is Data Grid. The title can be modified.
Widget Color – The color of the widget can be changed using the Change Widget Themeicon to the left of the widget title.
Cancel – Select the Close without Saving button to exit the Widget Editor without saving changes.
Save – Changes will be applied to the widget by clicking on the Save button. The Widget Editor screen will close after the save operation is complete.
Help – The Help button connects to the online documentation related to the specific widget.
Report Chooser – This control is used to select the report to be used with this instance of the Data Grid widget. The name of the currently selected report (if applicable) is displayed by default. To select a different report, click the Choose a Report button or name of the report. The Report Chooser will open and display available reports. Select the desired report.
Note: Because the report output is displayed as rows of data in a grid, you must choose a report that produces a table of data (i.e., an IGridReport).
Report Parameters – The report parameters (e.g., facility, sample date range, etc.) can be edited by clicking on the Edit button to open the Report Parameter Editor for the selected report. A user with editor permission on the selected report may update the report.
After choosing a valid grid report, the widget will run the report and display the output columns for the report in a simple table. Use the table of columns to configure the grid displayed by the widget.
Show/Hide – The check box determines whether or not the column will be included in the data grid. The person viewing the data grid can show/hide columns within the grid itself, but they will only be able to see the columns that are selected in the widget editor. If a column is unchecked in the editor, the person viewing the data grid will not be able to see that column. Click the header check box to automatically show/hide all columns.
Column – The column names are listed as input text boxes. The name of the column is displayed in the grid as is but can be changed. For example, to display the SYS_LOC_CODE column as "Location", change the column name in the text box to "Location".
Width – This number is the approximate width of the column as a percentage of the entire width of the data grid. The default column width is 10. Adjust the column width as desired.
Up/Down Arrows – Click the up/down arrows to change the order of the columns as they are displayed in the data grid.
The Advanced tab displays the widget settings as raw JSON. This allows for easy copying and pasting, as well as maintaining the ability to edit, add, or remove properties. Improper editing of the JSON will make the widget stop working.