5. Widget Reference List

This chapter offers an overview of all available dashboard widgets and their options. It is meant to be a reference while working with DISQOVER. You can access sections from this chapter directly from the dashboard in DISQOVER: go to the widget’s chart settings (ui-bars, at the top right of each widget) and click the ui-question icon.

5.1. Filter widgets

5.1.3. Individual filter widgets

The ‘Individual filter widgets’ option is available as soon as at least one facet is selected in the “Create a new widget” panel. This option creates a new chart for every selected facet, choosing an adequate chart type based on the facet’s data type:

  1. Categorical (CAT): Bar chart.
  2. Date (DATE): Date histogram.
  3. Integer (INT): Histogram.
  4. Numerical value (VAL): Histogram.
  5. Location (LOCATION): Region heat map.
  6. Coordinates (COORD): Dot distribution map.
  7. Country (CTRY): Country heat map.

5.1.4. List Facet

A list facet widget displays a list of facet values. Each facet value contains a green bar which represents the number of instances for which the property values match a certain facet value. The list facet can be navigated with the controls in the bottom right corner. The amount of items per page depends on the size of the widget.

image

Figure 5.3 List facet.

Chart data

  • Bars (required): a categorical facet that defines the list items

Data options

  • Order by: the data can be sorted ascending or descending.
  • Search: you can provide a search string to filter the facet values from the list. This filter is also directly available in the bottom left corner of the widget.
  • Include missing: the instances that do not have a instance property defined for the selected facet can be included as an extra item.

Layout

  • Number of columns: defines in how many columns the list is split.
  • Row height: defines the height of one list item. This can be useful for facet values which contain images.

Selecting data

Filtering the data in the list facet can be achieved by clicking an item of choice. By default, this filters the data using OR logic. You can also click the vertical ellipsis (ui-more) on the left of the item which opens the filtering menu, which presents a number of filtering options (section 3.3.2). The selected values appear green, unselected values are gray and negative selections are red.

5.1.5. Compact list facet

A compact list facet widget displays a list of facet values. The difference with the list facet is that by default you only see your current filtered values. You can filter by clicking the arrow button (ui-chevron-down) which opens the list in a dropdown. Each facet value contains a green bar which represents the number of instances with that facet value. The list facet can be navigated with the controls in the bottom right corner.

An advantage of this widget over the list facet is that it does not request any data from the server before opening the dropdown, this increases the opening speed of dashboards.

image

Figure 5.4 Compact list facet.

Chart data

  • Bars (required): a categorical facet that defines the list items

Data options

  • Order by: the data can be sorted ascending or descending.
  • Search: you can provide a search string to filter the facet values from the list. This filter is also directly available in the bottom left corner of the widget.
  • Include missing: the instances that do not have a instance property defined for the selected facet can be included as an extra item.

Selecting data

Filtering the data in the list facet can be achieved by clicking an item of choice. By default, this filters the data using OR logic.

You can also click the vertical ellipsis (ui-more) on the left of the item to open the filtering menu, which presents a number of filtering options (section 3.3.2). The selected values appear green, unselected values are gray and a negative selection is red.

5.1.6. Tree facet

A tree facet widget displays a list of hierarchical facet values. Each facet value contains a green bar which represents the number of instances with that facet value. The tree facet can be navigated with the controls in the bottom right corner. The amount of items per page depends on the size of the widget. In a tree facet you can open and close leaves to see the related children of a leaf.

image

Figure 5.5 Tree facet: investigators grouped by surname and initials.

Chart data

  • Bars (required): a hierarchical tree facet that defines the tree data.

Data options

  • Order by: the data can be sorted ascending or descending.
  • Search: you can provide a search string to filter the facet values from the tree. This filter is also directly available in the bottom left corner of the widget.
  • Include missing: instances that do not have a instance property defined for the selected facet can be included as an extra item.

Selecting data

You can open and close leaves of the tree by clicking the arrows (ui-chevron-right) on the left side of the items. Filtering the data in the list facet can be achieved by clicking an item of choice. This filters the data using OR logic. The selected values appear green, the unselected values are gray.

5.1.7. Compact tree facet

A compact tree facet widget displays a list of hierarchical facet values. The difference with the tree facet is that by default you only see your current filtered values.

You can filter the values by clicking the arrow down button (ui-chevron-down) which opens the tree list in a dropdown. Each facet value contains a green bar which represents the number of instances with that facet value. The tree facet can be navigated with the controls in the bottom right corner. The amount of items per page depends on the size of the widget. In a tree facet you can open and close leaves to see the related children of a leaf.

A benefit of this widget over the tree facet is that it does not request any data from the server before opening the dropdown, this increases the opening speed of dashboards.

image

Figure 5.6 Compact tree facet.

Chart data

  • Bars (required): a hierarchical tree facet that defines the tree data.

Data options

  • Order by: the data can be sorted ascending or descending.
  • Search: you can provide a search string to filter the facet values from the tree. This filter is also directly available in the bottom left corner of the widget.
  • Include missing: instances that do not have an instance property defined for the selected facet can be included as an extra item.

Selecting data

You can open and close leaves of the tree by clicking on the arrows (ui-chevron-right) on the left side of the items.

Filtering the data in the list facet can be achieved by clicking an item of choice. This filters the data using OR logic. The selected values appear green, while the unselected values are gray.

5.1.8. Range slider filter

This widget allows the user to filter a numerical facet using a range of values.

image

Figure 5.7 Range slider filter.

Chart data

  • Value (required): a numerical facet that is used to filter on.

5.1.9. Date filter

This widget allows the user to filter a date-type facet using a range of calendar dates.

image

Figure 5.8 Date filter widget, with calendar date picker expanded.

Chart data

  • Date (required): a date-type facet that is used to filter on.

5.1.10. Numerical value filter

This widget allows the user to filter a numerical facet using a range of values.

image

Figure 5.9 Numerical value filter.

Chart data

  • Value (required): a numerical facet that is used to filter on.

5.2. Analytics widgets

5.2.1. Bar chart

A bar chart displays a number of rectangular bars in a two-axis system, the height of each bar representing the number of instances (y-axis) for which the property values match a certain facet value (x-axis). Optionally, the bars can be split into colored pieces based on the value of a secondary facet.

image

Figure 5.10 Bar chart: the number of clinical studies (y-axis) by collaborator (x-axis) and colored by study phase.

Chart data

  • Bars (required): a categorical facet that defines the bars
  • Colors (optional): a categorical facet that defines the colors of the bar chart. Each bar is split into several pieces, their colors corresponding to different values of the secondary facet. The height of each piece is the number of instances that have a value of facet 1 as shown on the y-axis and a value of facet 2 as indicated in the legend.

Data options

  • Order by: the data can be sorted ascending or descending and both based on the x-axis labels or y-axis counts.
  • Include missing: the instances that do not have a instance property defined for the selected facet can be included as an extra bar. In case a secondary categorical facet is defined for the bar coloring, an extra bar piece is added to this bar of missing data.
  • Show as percentages: the y-axis can be rescaled to percentages, which means that the height does not represent the absolute number of instances but rather the percentage compared to the total number of instance property values.

Layout

  • Horizontal: Displays the bar chart with horizontal bars instead of the default vertical view.
  • Auto scale axis: when enabled, the x- or y-axis (depending on the Horizontal option) maximum value is automatically adjusted to the largest bar in the current set of visible bars. If this option is disabled, the value of the largest bar is used instead, regardless of the current position in the chart.
  • Color set: this option is only available when a secondary facet is defined and specifies which color palette is used.
  • Show colors in legend: this option is only available when a secondary facet is defined, and specifies whether the legend should be shown.
  • Y scale: the scaling of the y-axis can be changed from linear (default) to logarithmic (base 10).
  • Label space: defines the margin below the x-axis, and can be useful with long facet value labels.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the bar chart can be achieved by clicking a bar of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). A border appears around the part of the bar chart that is the basis for the selection: green or gray for a positive selection, red for a negative selection. The rest of the chart updates automatically, and the lay-out depends on the presence of a second facet. If no secondary facet was defined, the updated chart shows the selected instances in green and the others in gray. If there is a secondary facet, the part of the chart that is selected retains its original coloring while the deselected part turns transparent.

Some instances have multiple instance property values for a single facet (“multi-valued instances”), and are therefore represented in the bars of each of these values. If a filter is used to select or unselect these instances based on one of their property values, the selection or unselection of this instance is extended to the other bars.

Possible warnings and errors

Two kinds of warnings can be shown when displaying a bar chart with a secondary facet defined for coloring:

  • If the secondary facet has more than 12 values, only the 12 facet values with the largest number of instances are shown. A warning message appears stating the secondary facet has been clipped to 12 states.
  • If instances can be multi-valued for the secondary facet, the sum of the heights of the colored pieces in a bar can be higher than the height of that bar, as multi-valued instances are counted more than once. A “ui-warning Multi-valued”-warning message appears at the top of the color legend.

5.2.2. Pie chart

A pie chart displays the relative number of instances for each value of a categorical facet as slices of a circle. Optionally, the slices can have different radii based on the value of a secondary numerical facet.

image

Figure 5.11 Pie chart: the proportion of clinical study phases as slices and the average duration for each phase on the radius.

Chart data

  • Categories (required): a categorical facet that defines the different slices.
  • Quantifications (optional): a secondary numerical facet that determines the radius or angle of each slice.

Data options

  • Display quantifications as: the quantification can be visualized as the radius or angle of a slice.
  • Order by: the data can be sorted ascending or descending based on the count or the label.
  • Radius variable: if a secondary facet is defined, the aggregation type that defines the radius or angle of each slice can be chosen.
  • Include missing: instances that do not have a instance property defined for the selected facet can be included as a new slice.

Layout

  • Color set: specifies which color palette is used to color the slices.
  • Axis scale: this option is only available when a secondary facet is defined and specifies the scale of the radial axis which can be changed from linear (default) to logarithmic (base 10).
  • Pie size: scales the size of the entire pie chart.
  • Smallest slice: defines the smallest fraction for which a slice is displayed in the chart.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering dashboard data using the pie chart can be achieved by clicking a slice of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). After selecting a slice, all subsequent filtering actions are based on facet value represented by the slice. The slices which were the basis for the filter are highlighted with a colored border: green for a positive selection, red for a negative selection. If a filter is applied, each slice of the pie chart may contain a sub-slice indicating the number of instances which are included in the filter.

Possible warnings and errors

Two warnings can be shown when displaying a pie chart:

  • If the primary facet is multi-valued, a single instance may contribute to more than one slice. A warning is displayed in the chart legend, stating that the primary facet is multi-valued.
  • If a secondary numerical facet is selected, a warning stating that the values are not additive may appear depending on whether the selected aggregation type is additive.

5.2.3. Multistate chord diagram

The multistate chord diagram is used to examine which values frequently occur together in a multi-valued categorical facet. The different slices of the circle reflect the relative amount of instances for each facet value. The connections between the slices indicate that instances can have both values as property values. The sides of the connections represent the percentage of instances that have both values relative to the circle.

image

Figure 5.12 Multistate chord diagram: the target conditions of a clinical trial as slices, and the co-occurrence of target conditions indicated by connections.

Chart data

  • Slices (required): defines the categorical facet used to create the multistate chord diagram.

Data options

  • Maximum number of segments: the maximum number of facet values included in the diagram.
  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard or only the currently selected ones.

Layout

  • Pie size: scales the size of the entire pie chart by choosing its radius as a percentage relative to the window size.
  • Color set: specifies which color palette is used to color the segments.
  • Smallest chord size: defines the minimum size for a chord to be visible on the diagram. If both sides of a connection are smaller than the chosen percentage (relative to the circle), the connection is hidden to improve the readability of the graph.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the multistate chord diagram can be achieved by clicking a segment or a connection. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). You can filter on a facet value by clicking its corresponding segment. Conversely, if you click a connection, the filter combines both connected facets values with AND logic.

Note that after applying the filter action the multistate chord diagram is only updated if the data option ‘Show filtered data’ is enabled.

Possible warnings and errors

There are two possible errors related to a multistate chord diagram:

  • If the facet is single-valued, there cannot be connections between values, as no instance has more than one value for this facet. A warning is displayed in the legend.
  • If there are more facet values than the maximum number of segments chosen in the data options, a warning is shown at the bottom of the chart saying the chart is clipped to a limited number of states.

5.2.4. Histogram

A histogram shows a numerical facet by grouping the values into a number of bins, and displaying the number of instances in each of them. The bins are displayed as bars along the x-axis, with the height of the bar along the y-axis indicating the count for each bin. Optionally, the bars can be split into colored pieces based on the value of a secondary facet.

image

Figure 5.13 Histogram: the number of clinical studies (y-axis) by duration (x-axis), and colored by study phase.

Navigating the chart

By default, the histogram displays the full range of values along the x-axis. You can to zoom in on a particular range using the zoom buttons at the top. The resolution of the bins is automatically adapted to the zoom range. When zoomed in, the user can pan through the chart by hovering over the side of the chart (as indicated by the arrows ui-arrowleft and ui-arrowright), or by dragging the chart content using the mouse.

Chart data

  • Values (required): defines the numerical values used to create the histogram.
  • Colors (optional): a categorical facet that defines the colors of the histogram. Each bar is split into several pieces, their colors corresponding to different values of the secondary facet. The height of each piece is the number of instances that have a value of facet 1 as shown on the y-axis and a value of facet 2 as indicated in the legend.

Layout

  • Auto scale Y axis: when enabled, the y-axis maximum value is automatically adjusted to the largest bar in the current set of visible bars. If this option is disabled, the value of the largest bar is used instead, regardless of the current position in the chart.
  • Color set: this option is only available when a secondary facet is defined and specifies which color palette is used.
  • Show colors in legend: this option is only available when a secondary facet is defined, and specifies whether the legend should be shown.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the histogram chart can be achieved by toggling the range selection mode using the crop indicator button (crop-regular) at the top. When the the range selection mode is active, you can drag a range in the chart area to filter instances that belong to that range.

Possible warnings and errors

If a secondary facet is defined, an error message is possible:

  • If instances can be multi-valued for the secondary facet, the sum of the heights of the colored pieces in a bar can be higher than the height of that bar, as multi-valued instances are counted more than once. A “ui-warning Multi-valued”-warning message appears at the top of the color legend.

5.2.5. Date histogram

A date histogram shows a date facet by grouping the values into a number of date range bins and displaying the number of instances in each of them. The bins are displayed as bars along the x-axis, with the height of the bar along the y-axis indicating the count for each bin. Optionally, the bars can be split into colored pieces based on the value of a secondary facet.

image

Figure 5.14 Date histogram: the number of clinical trials (y-axis) by completion date (x-axis) and colored by status.

Navigating the chart

By default, the histogram displays the full range of values along the x-axis. You can to zoom in on a particular date range using the zoom buttons at the top. The resolution of the bins is automatically adapted to the zoom range. When zoomed in, you can pan through the chart by hovering over the side of the chart (as indicated by the arrows ui-arrowleft and ui-arrowright), or by dragging the chart content using the mouse.

Chart data

  • Date (required): defines the date facet used to create the date histogram.
  • Colors (optional): a categorical facet that defines the colors of the histogram. Each bar is split into several pieces, their colors corresponding to different values of the secondary facet. The height of each piece is the number of instances that have a value of facet 1 as shown on the y-axis and a value of facet 2 as indicated in the legend.

Data options

  • Bin size: if set to “Automatic”, the bin size is automatically determined from the zoom range. Alternatively, a fixed data range bin size can be specified using the drop down box.
  • Show as percentages: scales the y-axis to percentages, which means the height does not represent the absolute number of instances per bin but rather the percentage compared to the total number of instance property values in the bin.

Layout

  • Auto scale Y axis: when enabled, the y-axis maximum value is automatically adjusted to the largest bar in the current set of visible bars. If this option is disabled, the value of the largest bar is used instead, regardless of the current position in the chart.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the histogram chart can be achieved by toggling the range selection mode using the crop indicator button (crop-regular) at the top. When the the range selection mode is active, you can drag a date range in the chart area to filter instances that belong to that range.

Possible warnings and errors

If a secondary facet is defined, an error message is possible:

  • If instances can be multi-valued for the secondary facet, the sum of the heights of the colored pieces in a bar can be higher than the height of that bar, as multi-valued instances are counted more than once. A “ui-warning Multi-valued”-warning message appears at the top of the color legend.

5.2.6. Region heat map

A region heat map shows the number of instances or the value of a numerical facet within a region on different geographical levels.

image

Figure 5.15 Region heat map: the number of instances per state in the United States.

Navigating the chart

By default the map is completely zoomed out. You have the option to zoom in or out by using the zoom options available at the top. You can also zoom by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, you also have the option to pan through the map by hovering over the sides of the map as indicated by the the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown, or by dragging the map around.

Chart data

  • Location (required): a facet of the data type “location”.
  • Values (optional): a numerical facet that defines the color code of the regions.

Region

  • Region: The geographical region that should be shown on the map.
  • Sub level: The level of detail that is shown, for example States or Counties in the United States of America.

Data options

  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard, or only the currently selected ones.

Layout

  • Show disjunct areas: toggles whether overseas or otherwise disjunct areas are included in the map.
  • Data colors: defines the color scheme of the heat map.
  • Gamma factor: a value lower than 1 compresses the value range, lowering the relative difference between low and high values. This can be used to even out extreme values.
  • Border style: defines the color of the sublevel and country borders.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the region heat map can be achieved by clicking on a geographic region of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2).

Possible warnings and errors

  • Data Missing: XX: The number of instances that have information on a higher level, but not the currently displayed level. If one is viewing the ‘United States of America’ map at Level ‘Counties’ and an instance has only information up to the level of the states (e.g. Facility Location: ‘United States > California’), it gets counted as ‘data missing’.

  • Region Missing: XX: The number of regions for which there are instances with data that are unable to be displayed on the current map. This can be caused by one of the following:

    • Multivalued data points. Example: If an instance has a location facet with the following values: ‘France > Normandie, US > California’ and this is displayed on a region heat map with top region ‘USA’, it will generate one region that cannot be displayed on the USA map: ‘Normandie’.
    • Non-existing regions. It could be that the data contains non-existing regions. Example: up to 2016, the NUTS-region FR3 was used for the region ‘Nord’. Ingesting data from before 2016 results in a region that cannot be displayed at the current ‘Europe (NUTS regions)’ map, since the region FR3 doesn’t exist anymore.

5.2.7. Dot distribution map

A dot distribution map shows the location of instances on a map. Optionally, the dots can be colored by another facet of any type or sized by a numerical facet.

image

Figure 5.16 Dot distribution map: the location of instances.

Navigating the chart

By default the map is zoomed to fit all instances. You have the option to zoom in or out by using the zoom options available at the top. You can also zoom by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, you also have the option to pan through the map by hovering over the sides of the map as indicated by the the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown, or by dragging the map around.

Chart data

  • Coordinates (required): a facet containing the coordinates of the instances.
  • Color by (optional): a facet of any data type that defines the color of the dots.
  • Size by (optional): a numerical facet that defines the size of the dots.

Data options

  • Maximum number of instances: the maximum number of instances that is shown on the map.
  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard or only the currently selected ones.

Layout

  • Colors: specifies which color palette is used.
  • Stroke: specifies the color of the border of the dots.
  • Opacity: sets the opacity of the dots. This may help tuning the visualization in case of overlapping dots.
  • Size: scales the size of the dots.
  • Size gamma factor: a value lower than 1 compresses the value range, lowering the relative difference between low and high values. This can be used to even out extreme values.
  • Cluster: When turned on, dots close to each get grouped into bigger circles. The number inside the circle shows how many instances are grouped within.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

You can select instances based on their geographic location, by clicking the radius icon (ui-radius) at the top of the chart. This lets you specify a center point and radius, and selects all instances located within that circle.

You can readjust the filter by dragging the center and radius, or by entering a radius at the top of the graph.

Possible warnings and errors

  • If the number of instances exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget.

5.2.8. Heat map

A heat map shows a heat image generated from instances on top of a map. The heat increases as more dots are lying close to each other. Optionally, how much one instance contributes to the heat can be defined by a numerical facet.

image

Figure 5.17 Heat map from instances.

Navigating the chart

By default the map is zoomed to fit all instances. You have the option to zoom in or out by using the zoom options available at the top. You can also zoom by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, you also have the option to pan through the map by hovering over the sides of the map as indicated by the the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown, or by dragging the map around. When zooming in, the individual dots making up the heat map become visible.

Chart data

  • Coordinates (required): a facet containing the coordinates of the instances.
  • Weight by (optional): a numerical facet that defines the weight of each instance. By default, if this option is not set, every instance has the same weight.

Data options

  • Maximum number of instances: the maximum number of instances that is shown on the map.
  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard or only the currently selected ones.

Layout

  • Colors: specifies which color palette is used.
  • Weight: multiplies the weight of each instance. Increasing this value increases the overall intensity of the heat map.
  • Radius: defines the distance each instance influences. Increasing this value increases the bluriness of the heat map.
  • Gamma factor: a value lower than 1 compresses the value range, lowering the relative difference between low and high values. This can be used to even out extreme values.
  • Show instances from zoom level: when zooming in, the individual dots making up the heat map become visible. A lower value means that they will appear sooner.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

You can select instances based on their geographic location, by clicking the radius icon (ui-radius) at the top of the chart. This lets you specify a center point and radius, and selects all instances located within that circle.

You can readjust the filter by dragging the center and radius, or by entering a radius at the top of the graph.

Possible warnings and errors

  • If the number of instances exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget.

5.2.9. Country heat map

A country heat map shows the number of instances per country as a color-coded world map. Optionally, a second numerical facet can be used to color code the countries.

image

Figure 5.18 Country heat map: the number of people enrolled in clinical trials by country.

Navigating the chart

By default the map is completely zoomed out. You have the option to zoom in or out by using the zoom options available at the top. You can also zoom by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, you also have the option to pan through the map by hovering over the sides of the map as indicated by the the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown, or by dragging the map around.

Chart data

  • Country data (required): a facet of the data type “country”.
  • Values (optional): a numerical facet that defines the color code of the countries.

Data options

Several data options are available for the country heat map:

  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard, or only the currently selected ones.
  • Quantification: if a secondary facet type is selected, the following types of quantifications can be used per facet state in the country map:
    • Average, Minimum, Maximum and Standard deviation: aggregated statistics per country.
    • Total: shows the summed value over all instances in the country.

Layout

  • Colors: specifies which color palette is used to color code the countries.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the country heat map can be achieved by clicking on a country of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). After selecting a country, all subsequent filtering actions are based on that facet state. The selected country is hatched: green for a positive selection, red for a negative selection.

Possible warnings and errors

  • If the “Total” quantification is used for a facet that is not configured to be additive, a warning is displayed indicating that this sum may not have a meaningful value.

5.2.10. Country symbol map

Displays the number of instances per country as a sized disk on a world map. Optionally, the values of a second categorical facet can be visualised as a pie chart for each country.

image

Figure 5.19 Country symbol map: the target gender of clinical studies by country.

Navigating the chart

By default the map is completely zoomed out. You have the option to zoom in our out by using the zoom options available at the top. You can also zoom by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, you have the option to pan through the map by hovering over the sides of the map as indicated by the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown, or by dragging the map around.

Chart data

  • Country data (required): a facet of the data type “country”. The total number of instances per country is represented in the size of the disk.
  • Piechart data (optional): a categorical facet that defines the pie charts.

Layout

  • Color set: this option is only available when a secondary facet is defined and specifies which color palette is used.
  • Disk size: adjusts the size of the pie charts
  • Opacity: adjusts the opacity of the pie charts. Lower values make it easier to see through pie charts in case of overlaps.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the country heat map can be achieved by clicking a country of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). After selecting a country, all subsequent filtering actions are based on that facet state. The selected country is hatched: green for a positive selection, red for a negative selection.

Possible warnings and errors

Two warnings can be shown when displaying a country symbol map with a secondary facet defined for coloring:

  • If the secondary color facet has more than 12 facet values, only the 12 facet values with the largest number of instances are shown. A warning message appears at the bottom of the chart stating the secondary facet has been clipped to 12 states.
  • If instances can be multi-valued for the secondary facet, the sum of the slice sizes can be higher than the total number of instances for that country, as multi-valued instances are counted more than once. A “ui-warning Multi-valued”-warning message appears at the top of the color legend.

5.2.11. Dual value histogram

A dual value histogram divides two numerical facets into a number of bins shown on the x and y axis, and shows the number of instances in each bin as a sized disk.

image

Figure 5.20 Dual value histogram: the maximum age of a clinical study participant (y-axis) by the duration of the clinical study (x-axis).

Navigating the chart

By default, the dual value histogram displays the full range of values along the axes. You can to zoom using the zoom buttons at the top or by holding the ctrl-key and using the scroll wheel on the mouse. When zoomed in, the you can pan through the chart by hovering over the side of the chart (as indicated by the arrows ui-arrowleft and ui-arrowright), or by dragging the chart content using the mouse.

Chart data

  • X Axis (required): a numerical facet that forms the x-variable.
  • Y Axis (required): a numerical facet that forms the y-variable.

Data options

  • Resolution: sets the size of the bins.

Layout

  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering data in a dual value histogram can be achieved by switching on the select range tool in the top right corner, indicated by a crop sign (crop-regular). When activated, the range tool allows you to drag a rectangle and filter the data according to the x and y range of the selected area. If a filter is applied to the dashboard, the disks are colored either green or gray if the instances in them are part of the selection or not.

5.2.12. Aggregated value

This widget displays an aggregated value (average, total, minimum or maximum) for a numerical facet. This two values are displayed: for the currently filtered instances (larger font), and for all instances in the dashboard (smaller font).

image

Figure 5.21 Aggregated value widget: the average duration of clinical studies.

Chart data

  • Values (required): a numerical facet that should be aggregated.

Data options

  • Aggregation: defines how the facet values should be aggregated. Possible options are: average, total, minimum or maximum.

Layout

  • Unit: a piece of text to be shown next to the aggregated value.
  • Font size: a relative indicator of the size of the font used to render the value.

5.2.13. Scatterplot

A scatter plot displays two numerical facets as X and Y axis of a plot, with each instance represented by a bubble. Optionally, a third and fourth facet can be used to control the size or color of each bubble.

image

Figure 5.22 Scatterplot: the maximum and minimum ages of clinical trial participants, colored by study phase and scaled by duration of the study.

Navigating the chart

Chart zoom options are available at the top. When zoomed in, you have the option to pan through the bar chart by hovering over the side of the chart, as indicated by the arrows ui-arrowleft and ui-arrowright, or by dragging the chart with the mouse.

Chart data

  • X axis (required): a numerical facet that forms the x-variable of the scatter plot.
  • Y axis (required): a numerical facet that forms the y-variable of the scatter plot.
  • Color (optional): a categorical facet that defines the color of each bubble.
  • Bubble size (optional): another numerical facet that defines the bubble size of each bubble

Data options

  • Maximum number of instances: sets the maximum number of instances (= number of bubbles) that are displayed in the scatter plot. If this number is lower than the number of instances, the plot contains a random subset.

Layout

  • Show labels: when turned on, the labels of the instances are shown on the chart.
  • Size factor: scales the size of the bubbles.
  • Opacity: sets the opacity of the bubbles. This may help tuning the visualization in case of overlapping bubbles.
  • Color set: this option is only available when a color facet is defined and specifies which color palette is used.
  • Point connection: connects the dots on the plot linearly, smooth or step wise.
  • Show colors in legend: adds a legend that contains the colors of the color facet.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Ranges

By default, the startvalue and endvalue of both the x-axis and y-axis are set automatically to the lowest and highest value in the data set. Set these values here to override the defaults.

Selecting data

Filtering data in a scatter plot can be achieved by switching on the select range tool in the top right corner, indicated by a crop sign (crop-regular). When activated, the range tool allows the user to drag a rectangle and filter the data according to the x and y range of the selected area. If a filter is applied to the dashboard, the bubbles are colored either green or gray if the instance is respectively part of the selection or not. The selected filter is only visible if no categorical facet is selected for coloring the scatter plot.

Possible warnings and errors

  • If the number of instances exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget

5.2.14. Pivot table

A pivot table displays the states of two categorical facets as rows and columns, indicating the number of instances in each cell using a color code. Optionally, a third numerical facet can be used to color code the cells.

image

Figure 5.23 Pivot table: the country of clinical studies versus their collaborator. The average duration is shown in the cells as both a value and a color.

Navigating the chart

If the number of different facet values is too large, only a certain number of them is displayed on the x-axis at the same time by default. You have the option to pan through the pivot table by hovering over the side of the chart (as indicated by the arrows ui-arrowleft, ui-arrowright, ui-arrowup and ui-arrowdown), or by dragging the content using the mouse. Alternatively, more or less of the chart can be shown by using the zoom options available at the top. Facet labels on the x-axis are hidden if the zoom state would render them illegible.

Chart data

  • Rows (required): the categorical facet defining the rows.
  • Columns (required): the categoricel facet defining the columns.
  • Values (optional): the numerical facet that color-codes the cells in the table.

Data options

  • Maximum number of columns: the maximum number of columns used on the x-axis.
  • Order rows by: sorts the rows ascending or descending based on either the labels or the counts.
  • Indicate filtered values: shows the fraction of selected data as a bar within each cells if filters are applied.
  • Quantification: if a coloring facet type is selected, the following types of quantifications can be used per cell in the table:
    • Average, Minimum, Maximum and Standard deviation: aggregated statistics per country.
    • Total: shows the summed value over all instances in the country.

Layout

  • Colors: specifies which color palette is used to color code the cells.
  • Range: This option is only available when a third numerical facet is not defined. You can use it to alter the color coding using a Linear, logarithmic or Semi-logarithmic range.
  • Label space: defines the margin below the x-axis, or next to the y-axis, and can be useful with long facet value labels.

Selecting data

Filtering the dashboard data in the pivot table can be achieved by clicking a cell. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). A selected cell has a blue border. You can only filter on one cell at a time.

Possible warnings and errors

  • If the number of secondary facets exceeds the maximum number of columns, a warning stating ‘Clipped to … secondary states’ is shown.

5.2.15. Clustered bar chart

A bar chart displays the number of instances per facet values as colored vertical bars, grouped by the values of a another facet (clusters).

image

Figure 5.24 Clustered bar chart: the number of clinical studies by country and target gender.

Chart data

  • Clusters (required): a categorical facet that defines the clusters
  • Bars (required): a categorical facet that defines the bars

Data options

  • Order clusters by: the clusters can be sorted ascending or descending and both based on the x-axis labels or y-axis counts.
  • Include missing: the instances that do not have a instance property defined for the selected facet can be included as an extra bar.

Layout

  • Auto scale Y axis: when enabled, the y-axis maximum value is automatically adjusted to the largest bar in the current set of visible bars. If this option is disabled, the value of the largest bar is used instead, regardless of the current position in the chart.
  • Color set: specifies which color palette is used.
  • Show colors in legend: specifies whether the legend should show the color and their facet values.
  • Y scale: the scaling of the y-axis can be changed from linear (default) to logarithmic (base 10).
  • Label space: defines the margin below the x-axis, and can be useful with long facet value labels.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the bar chart can be achieved by clicking a bar of choice. This opens the filtering menu, where the filter can be set. A border appears around the part of the bar chart that is the basis for the selection.

Some instances have multiple instance property values for a single facet (“multi-valued instances”), and are therefore represented in the bars of each of these values. If a filter is used to select or unselect these instances based on one of their property values, the selection or unselection of this instance is extended to the other bars.

Possible warnings and errors

Two kinds of warnings can be shown when displaying a bar chart with a secondary facet defined for coloring:

  • If the bars facet has more than 12 values, only the 12 facet values with the largest number of instances are shown. A warning message appears stating the facet has been clipped to 12 states.
  • If instances can be multi-valued for the bars facet, a “ui-warning Multi-valued”-warning message appears at the top of the color legend.

5.2.16. Box & whiskers chart

A box & whiskers chart displays trends of a numerical facet over the different values of a categorical facet. The latter are listed as columns along the x-axis, and for each column the following elements are displayed:

  • Box: the standard deviation range around the average value for that state (indicated as a horizontal line in the center of the box).
  • Whiskers: vertical lines extending from the box, and indicating the overall minimum and maximum value present for that state.
image

Figure 5.25 Box & whiskers chart: study phase versus duration.

Navigating the chart

If the number of different facet values is too large, only a certain number of them is displayed on the y-axis at the same time. You can pan through the bar chart by hovering over the side of the chart (as indicated by the arrows ui-arrowleft and ui-arrowright), or by dragging the chart content using the mouse. Alternatively, more or less of the chart can be shown by using the zoom buttons available at in the top right corner. Facet labels on the x-axis are hidden if the zoom state would render them illegible.

Chart data

  • Bars (required): a categorical facet that defines the bars
  • Values (required): a numerical facet that creates the boxes and whiskers for each bar.

Data options

Several data options are available for the bar chart:

  • Order by: sorts the bars ascending or descending based on the count or label.
  • Quantification: uses one of the following types of quantifications per bar in the chart:
    • Box & whiskers: shows the average, standard deviation, minimum and maximum values.
    • Average, Minimum or Maximum: shows aggregated statistics.
    • Total: shows the summed value over all instances in the bar.
  • Include missing: includes missing data as a new box & whiskers.

Layout

  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Range

  • Minimum Y value: Start value of y-axis. Leave empty to set the minimum value automatically to the lowest value in the data set.
  • Maximum Y value: End value of y-axis. Leave empty to set the maximum value automatically to the highest value in the data set.

Selecting data

Filtering the dashboard data by facet states in the chart can be achieved by clicking on a column of choice. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). After selecting a facet state, all subsequent filtering actions are based on that facet state.

If a filter is active, the selected data is shown as a secondary, green box & whiskers on top of a gray box & whiskers displaying all data. If a box & whiskers chart is used as an exclusion filter, it is grayed out and the label name is shown on a red background.

Possible warnings and errors

  • If the “Total” quantification is used for a facet that not configured to be additive, a warning is displayed indicating that this sum may not have a meaningful value.

5.2.17. Sankey diagram

A Sankey diagram shows the correlation between two categorical facets. The facets are located on opposing sides of the chart, and colored segments represent the relative occurrence of the different facet values.

Chords connect combinations of facet values that occur within the same instance. The relative sizes of the chords represent the percentage of instances with that specific combination of facet values.

image

Figure 5.26 Sankey diagram: the phase of a clinical study is shown on the left, the target condition on the right. The chords represent combinations of phase and condition. For example, many phase 1 studies target healthy test subjects.

Chart data

  • From (required): defines the first categorical facet.
  • To (required): defines the second categorical facet.

Data options

  • Maximum number of left segments: the maximum number of facet values for the first facet included in the diagram.
  • Maximum number of right segments: the maximum number of facet values for the second facet included in the diagram.
  • Show filtered data only: toggles whether the chart shows information for all instances in the dashboard or only the currently selected ones.

Layout

  • Left color set: specifies which color palette is used to color the segments of the first facet.
  • Right color set: specifies which color palette is used to color the segments of the second facet.
  • Smallest chord size: defines the minimum size for a chord to be visible on the diagram. If both sides of a connection are smaller than the chosen percentage, the connection is hidden to improve the readability of the graph.
  • Sorting method: specifies the algorithm that defines the order of facet values.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Selecting data

Filtering the dashboard data in the Sankey diagram can be achieved by clicking a segment or a connection. This opens the filtering menu, which presents a number of filtering options (section 3.3.2). You can filter on a facet value by clicking its corresponding segment. Conversely, if you click a connection, the filter combines both connected facet values with AND logic.

Possible warnings and errors

There are several possible warnings related to a Sankey diagram:

  • If at least one of the chosen facets is multi-valued, a single instance may contribute to more than one slice. A warning is displayed in the chart legend, stating that the facet is multi-valued.
  • If there are more facet values than the maximum number of segments chosen in the data options, a warning is shown at the bottom of the chart saying the chart is clipped to a limited number of states.
  • If a filter is active, the Sankey diagram only reflects the filter if the “Show filtered data” option is enabled. The legend shows whether the chart consists of “Unfiltered data” or “Filtered data only”
  • If some chords are smaller than allowed by the “Smallest chord size” option, the legend shows the smallest allowed chord size.

5.2.18. Parallel coordinates plot

A parallel coordinates plot shows vertical axes containing numerical facets, and for each instance connects the values of that instance for those facets with a line. Optionally, the lines can be colored by a categorical facet.

image

Figure 5.27 Parallel coordinates plot: the vertical axes are the maximum age, duration and number of enrolled people of clinical studies. Each line represents a clinical study, and connects the values for that study on the three axes. Lines are colored by study phase.

Navigating the chart

Chart zoom options are available at the top. When zoomed in, you have the option to pan through the bar chart by hovering over the side of the chart, as indicated by the arrows ui-arrowleft and ui-arrowright, or by dragging the chart with the mouse.

Chart data

  • Values (2 required, more optional): numerical facets that define the vertical axes.
  • Colors (optional): a categorical facet that defines the colors of the lines.

Data options

  • Maximum number of instances: sets the maximum number of instances (= number of lines) that are displayed in the parallel coordinates plot. If this number is lower than the number of instances, the plot contains a random subset.

Layout

  • Use common y-axis: when switched on, all parallel axes have the same scale.
  • Color set: specifies which color palette is used for the color facet (if used).
  • Opacity: adjusts the opacity of the lines. Lower values make it easier to see through.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Possible warnings and errors

  • If the number of instances exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget
  • If the facet used for coloring is multivalued, a warning appears in the legend.

5.2.19. Violin plot

A violin plot shows a little ‘violin’ for each category. A violin is built up by the number of instances per value, smoothed out. Optionally, each instance can be further weighted by a numerical facet.

image

Figure 5.28 Violin plot: the number of clinical trials (y-axis) by country (x-axis).

Chart data

  • Values (required): defines the facet used to create the violins (y-axis).
  • Categories (required): defines the facet used on the x-axis.
  • Weight (optional): a numerical facet that used as multiplier for each instance.

Data options

  • Maximum number of instances: sets the maximum number of instances that are displayed in the chart. If this number is lower than the number of instances in the dashboard, the chart contains a random subset.
  • Order by: defines how the categorical values are orodered on the x-axis.

Layout

  • Bandwidth: A higher value will produce smoother violins.
  • Gamma compression factor: a value lower than 1 compresses the value range, lowering the relative difference between low and high values. This can be used to even out extreme values.
  • Bin width: Default thickness of the violins.
  • Label space: Width of the category label.

Ranges

  • Minimum Y value: Start value of y-axis. Leave empty to set the minimum value automatically to the lowest value in the data set.
  • Maximum Y value: End value of y-axis. Leave empty to set the maximum value automatically to the highest value in the data set.

5.3. Instances widgets

5.3.1. Property list

The property list widget shows properties for all instances. When the widget is configured to show columns, the instances can be sorted by property value by clicking on the column header (provided the property in the column is sortable).

property list widget

Figure 5.29 Property list widget.

Data options

  • Include unselected instances: toggles whether the chart shows information for all instances in the dashboard, or only the currently selected ones.

Editor

The content of the property list can be edited similar to the instance list by clicking the pencil icon at the top of the widget (ui-pencil). See section 4 for more information.

5.3.2. Property Table

The property table widget shows properties for all instances, similarly to the instance table view on the right side of the screen (section 3.2.1). The content of the property table can be edited similarly (see section 4 for more information).

property table widget

Figure 5.30 Property table widget.

Data options

  • Include unselected instances: toggles whether the chart shows information for all instances in the dashboard, or only the currently selected ones.

5.3.3. Stacked time periods

This chart displays each instance as a time period, stacked on a time line. Optionally, the time periods an be grouped and / or colored by a categorical facet.

image

Figure 5.31 Stacked time periods: clinical studies over time, grouped by study phase and colored by target gender.

Chart data

  • Start date (required): a date facet that defines the beginning of the time period.
  • Stop date (required): a date facet that defines the end of the time period.
  • Interval date(s) (optional): one or more date facets that define intermediate points in the period.
  • Y position (optional): if this is set to a numerical facet, time periods are not stacked but assigned to a Y position on a vertical scale.
  • Color (optional): a categorical facet that determines the color of each instance time period.
  • Groups (optional): a categorical facet that is used to group the instance time period in separate sections.

Data options

  • Maximum number of instances: sets the maximum number of instances (= number of time periods) that are displayed in the chart. If this number is lower than the number of instances in the dashboard, the chart contains a random subset.

Layout

  • Opacity: sets the opacity of the period bars. This may help tuning the visualization in case of overlapping bars.
  • Color set: this option is only available when a color facet is defined and specifies which color palette is used.
  • Stacking: determines how the periods are stacked.
    • Smart stacking: stacking is optimised to provide maximum space.
    • Stacked by start date: periods are ordered by start date and then stacked.
    • Stacked by stop date: periods are ordered by stop date and then stacked.
    • Stacked by duration: periods are ordered by duration and then stacked.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Possible warnings and errors

  • If the number of instances in the dashboard exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget.

5.3.4. Instance pivot table

This widget displays the values of a facet for each individual instance in the dashboard, structured as a matrix with the rows representing different instances, and the columns representing different facet values. This is particularly useful for multi-valued facets.

image

Figure 5.32 Instance pivot table: clinical studies versus the datasources that contain information on them.

Chart data

  • Pivot values (required): a multi-valued categorical facet.

Data options

  • Maximum number of instances: sets the maximum number of instances that are displayed in the chart. If this number is lower than the number of instances in the dashboard, the chart contains a random subset.
  • Order by: determines how the facet values are ordered.
    • Label (ascending): ordered alphabetically by the facet value labels.
    • Label (descending): ordered alphabetically by the facet value labels, in reverse order.
    • Count (result set): ordered by decreasing number of instances over the result set included in the chart.

Layout

  • Instance label space: sets the space in between the instance labels.
  • Values label space: sets the space for the value labels.
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Possible warnings and errors

  • If the number of instances in the dashboard exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the widget.

5.3.5. Stacked cards view

This widget displays instances as cards stacked in several columns, according to the facet values of a single-valued categorical facet. Each card shows the label of the instance.

image

Figure 5.33 Stacked cards view: clinical studies listed by study phase and colored by type.

Chart data

  • Column values (required): a single-valued categorical facet used to determine the column for each instance card.
  • Primary color (optional): a categorical facet used to attach a colored tag to the left side of each card. This facet can be multi-valued, in which case more than one color tag is attached.
  • Secondary color (optional): a categorical facet used to show a colored dot in the top right corner of each card. This facet must be single-valued.
  • Additional text (optional): one or more facets used to show additional text on the card.

Data options

  • Show selected only: when switched on, instances that are not in the currently active filter are not displayed.
  • Maximum number of instances: sets the maximum number of instances that are displayed in the view. If this number is lower than the number of instances in the dashboard, the view contains a random subset.
  • Order by: determines how the columns are ordered.
    • Label (ascending): ordered alphabetically by the facet value labels.
    • Label (descending): ordered alphabetically by the facet value labels, in reverse order.
    • Count (result set): ordered by decreasing number of instances over the result set included in the view.

Layout

  • Display style: controls the visual appearance of the cards.
    • Standard: cards are not overlapping.
    • Compact: cards are semi-overlapping. Hovering over a card causes it to pop out, showing the entire content.
  • Label line count: the maximum number of lines used to show the label text.
  • Primary color set: specifies which color palette is used for the primary color facet (if used)
  • Secondary color set: specifies which color palette is used for the secondary color facet (if used)
  • Legend: if applicable, the legend can be docked at the bottom of the chart, floating on top of the chart or hidden.

Possible warnings and errors

  • If the number of instances in the dashboard exceeds the specified maximum number of instances, a “Data is clipped to …”-warning appears at the bottom of the view.

5.4. Other widgets

5.4.1. Count

A count chart displays the number of filtered instances relative to the total number instances in the dashboard.

image

Figure 5.34 Count chart.

5.4.2. Collections membership

A collections filter allows you to filter instances belonging to a collection (see section 7). Clicking the widget opens a pop-up in which you can select one or more existing collections. You can use AND or OR logic to combine multiple collections. The instance list then only contains instances belonging to that selection.

image

Figure 5.35 A collections membership filter.

5.4.4. Search Path

The search path shows the steps leading to the current search results, including active filters.

image

Figure 5.37 Search Path.

Possible warnings and errors

A warning can be shown when the canonical type is of a mixed type (containing both local and public instances). A label is displayed after the provenance, stating the origin of the data (local or public).

5.4.7. Separator

This widget is a horizontal line that can be used as a separator.

image

Figure 5.41 A separator.

5.4.9. Static text

This widget shows custom text.

image

Figure 5.42 Static text.

Layout

  • Text: the text that should be shown in the widget. Markdown is supported.
  • Text size: the size of the text.
  • Weight: whether the font is default, bold or light.
  • Color: the color of the text.
  • Alignment: whether the text should be left, center or right aligned.

5.4.10. Open template button

This widget adds an action button to the dashboard that opens the same data in a new dashboard, with a different template. After creation of the widget, the “Select template…” button in the widget configuration menu can use used to select what template should be opened when a user clicks the action button.

image

Figure 5.43 Open template button with the configuration menu opened.

5.4.12. Color legend

This widget allows the user add a color legend to a dashboard that replaces the legends on individual widgets. For example, on a dashboard that contains multiple graphs that are color coded by country, a color legend widget can be used instead of the legends on each graph.

image

Figure 5.45 A color legend.

Chart data

  • Colors (required): a categorical facet.

Layout

  • Color set: the color of the colors shown in the legend.

5.4.13. Instance list post button

This widget adds an action button to the dashboard that sends a POST request in the browser, with the current set of instances added in JSON. To add this widget to a dashboard, you need to have the permission to add “advanced widgets”. This feature can be used to create an integration between DISQOVER and a third party web application. The format of this POST can be configured in the widget options.

Configuration options

  • JSON fields: one or more fields that are sent to the POST endpoint.
  • URL: the URL where the POST needs to be send.
  • Extra JSON fields: one or more JSON key value fields you can add to the request.
  • Custom headers: one or more custom headers you can add to the request.
  • Maximum number of instances: maximum number of instances that are put on the URL.

Additional information

By default the post request has 2 headers set:

  • Accept: ‘application/json’
  • Content-Type: ‘application/json’

The response of the POST endpoint should be in JSON. It can contain a message and/or a URL. This information is displayed when the POST completes.

5.4.14. Instance list linkout button

This widget adds an action button to the dashboard that opens a new URL in the browser, with the current set of instances added as query parameter. This feature can be used to create an integration between DISQOVER and a third party web application. The format of this URL can be configured in the widget options.

To add this widget to a dashboard, you need to have the permission to add “advanced widgets”.

Configuration options

  • Exported identifier: the instance property that is used to specify the instances in the URL.
  • URL prefix: the first, fixed part of the URL.
  • Identifier separator: in separator used to distinguish the identifiers of the different instances.
  • URL postfix: optionally, the final, fixed part of the URL.
  • Maximum number of instances: maximum number of instances that are put on the URL.
  • Maximum URL length: maximum overall character length of the URL. Note that this parameter has to be in line with browser and web application limitations.

Possible warnings and errors

A warning is indicated on the button in case

  1. the number of instances in the dashboard exceeds the configured maximum.
  2. the actual URL length exceeds the configured maximum.

In both cases, the actual number of instances used in the URL is clipped.