Using the Data Explorer Widget

The Data Explorer widget allows displaying, in a file-explorer-like interface, all or part of the data contained in the application.

Data Explorer Widget

  • On the left part, the Data Explorer lists all the entities of the data model. If a composite data model is used, the entities that are not present in the currently selected scenario type are greyed out and hovering over them displays a message stating "The selected scenario has no data for this table". The number of schema errors, if any, is indicated next to the entity name.

    Note:

    In the Data Explorer widget, GeneIssue, GeneParameter, and GeneSchemaIssue internal entities are hidden by default and, when displayed, they may contain rows referring to other scenarios than the one currently selected. In this case, they cannot be edited until said scenario is selected. For more details, please refer to Section Understanding Widget Context.

    Internal entities

  • On the right part, a panel is populated with a detailed Data Grid representing data of the selected type. For more details, please refer to Section Using the Data Grid Widget.

The Data Grid and Data Explorer are especially useful to compare scenarios. For more details, please refer to Section Understanding Scenario Comparison.

The layout of the widget columns can be edited. For more details, please refer to Section Understanding Table Widgets.

In use, the widget toolbar can display the:

  • Show issues only button, which only appears when there are issues in the displayed table, and which allows filtering the rows in the Data Grid to only display those with issues.

  • Edit button, which, when toggled, displays the option buttons Add new rows, Delete selected rows and Duplicate selected rows. It also displays the buttons Discard changes and Save changes to confirm, or not, any change on the scenario table, indicated by a yellow tag on the Edit button that shows the number of changes.

  • Selection button, which can be hidden via the widget configurator and which allows changing the way row selection is handled in the Data Grid.

  • Action button, which displays the:

    • Delete All rows option, to clear the whole table at once.

    • Reset Widget option, which is described more in details in Section Understanding Widget State.

    • Issues filters Other, Error, Warning and Info, which only appear if the Show issues only button is toggled on.

In the Data Grid, users can select: a cell, by clicking on it once; or several ones, by holding the Shift key while doing so or by holding and dragging the mouse click across a selection. Right-clicking on an entry, or a selection of entries, displays the following options:

  • Add new rows — only available when the widget option Edit is toggled on —, which allows adding a new row before the selected one(s) or at the beginning of the table if no row is selected.

  • Copy, to copy the selected cell(s).

  • Copy With Headers, to copy the selected row(s) with the column labels as first row.

  • Cut, to cut the selected cell(s).

  • Paste as new rows, to paste the cut or copied selection into new rows.

  • Chart Range, and several options to create a downloadable visualization of the selected rows.

  • Export, to download the content of the selected cell(s) into a CSV Export or Excel Export.

The widget settings can be edited using a dedicated configurator.

The upper tabs allow configuring the:

  • Header, i.e. the widget top bar, by setting if it must be shown by ticking Show Header and if so, by inserting its Title and Icon.

  • Colors, by ticking Use Custom Colors, and setting the Header Color and Text Color.

  • Toolbar, beneath the widget header, by adding configurable action buttons. For more details, please refer to Section Using the Action API.

  • Custom Controller in charge of customizing the widget behavior, set to None by default.

  • Scenario Comparison option to Automatically enable the Scenario comparison mode for the widget.

  • Filters that should only apply to the widget, in addition to any filters set at a more global level, such as the Filter widget. For more details, please refer to Section Using the Filter Widget.

The left panel lists all the entities present in the scenario data set.

The way each entity is displayed in the widget can be configured independently by selecting them in the left panel. Doing so refreshes the main tabs with the specific entity parameters.

Above the main tabs, parameters allow setting, for each entity table, the:

  • Title to display on the widget left panel to refer to the said Type,

  • Hide this Table option to remove the entity from the widget left panel — a hidden entity is displayed in italics in the configurator —, and the

  • Custom Controller to use for the Type, if need be.

The main tabs allow configuring the:

  • Properties of the table such as the:

    • Description of the table if need be.

    • Type, which refers to the specific table to display from the scenario dataset.

    • Query to filter the data to display, if need be.

    • Editable option to allow, or not, the modification of data in the table cells, and if so, another option to Forbid adding or deleting rows.

    • Show Data Validation issues in row number column option which pinpoints, in the table, any issue in the data set.

    • Show Selection Menu option to display the related Selection button in the toolbar, which allows to change the way row selection is handled in the Data Grid.

    • Hide 'Show issues only' button option to remove the button filtering only the rows containing issues.

    • Selection Mode option, set by default to none, which can also be set to select or highlight to change the way selecting rows with the mouse works.

  • Columns to display, with a list that allows sorting, adding, removing and duplicating them, and options to set the:

    • Column Header, by default set to the entity attribute to display.

    • Field, i.e the entity attribute to display, used by default for the column header.

    • Empty (null) value display, by default set to <NULL>.

    • Hide this column option, which also updates the column with the indication Hidden in the list.

    • Show/Edit Time option — only available for date and time columns — to display the time in addition to the date.

    • Value Format, which can be set to:

      • Date, using the format 10/3/2023, Oct. 3, 2023, October 3, 2023, or Thursday, October, 2023.

      • Time, using the format 3:50 PM, 3:50:55 PM, or 3:50:55 PM GMT+2.

      • Duration, using the format 8760:00:00 (hh:mm:ss), 525600 (Minutes), 8760 (Hours), 365 (Days), 52 (Weeks), 12 (Months), or 1 (Years).

      • Number, using the format 123,412%, 1,231 (Rounded value), 1,234.1, 1,234.12, 1,234.123, 1.234123e+3 (Scientific), 1.234e+3 (Scientific), 1.234K (thousands), 1K (thousands, rounded), 0.001M (millions), or 0M (millions, rounded).

      • Currency, using the format $ 1,234 (Rounded value), € 1,234 (Rounded value), 1,234 (Rounded value), $ 1,234.12 (Decimals), € 1,234.12 (Decimals) or 1,234.12 (Decimals).

      • Custom, which prompts the user to choose a formatter and a format, either ICU (Default), using the ICU message format, or Luxon (Date & Time), using the Luxon message format.

    • Conditional Formatting, using the button + ADD ANOTHER RULE that displays Custom style options to Apply style when the value Is null, Is not null, Is equal to, Is not equal to, Greater than, Greater than or equal to, Lower than, Lower than or equal to, Is between, Is not between, Is empty, Is not empty, Text contains, Text does not contain, Text starts with or Text ends with a certain value.

  • Advanced configuration, with parameters such as the:

    • Hide row number column option if need be.

    • Use pagination (legacy) option that provides the table with manual pagination settings.

    • Hide aggregation panel option — not compatible with the Use pagination (legacy) —, true by default, that hides the aggregated information displayed in the bottom-right corner of the table upon range selection (the aggregated information are computed from loaded data only).

    • Block size (max. elements per request) option, set by default to 50, to limit how many rows at a time are requested from the server.

    • Max. blocks in cache option, set by default to 20, to limit how many results from the server are kept in the application cache.