5.4. Listing items

5.4.1. Ordering the list
5.4.2. Filtering the list
Extending the search with multiple filter rows
Units
5.4.3. Configuring which columns to show
5.4.4. Presets
Save a preset
Manage presets

All pages that lists items are very similar in their appearance and functionality. In this section we will describe the things that are common for most (if not all) list pages.

Use the menu to open a page listing items. Most list pages can only list one type of items. For example: use the ViewSamples menu to list samples and the ViewExperiments menu to list experiments.

[Tip] Tip
An example of a list page that can list items of several types is found by going to ViewAll items. This page lists all items that you are the owner of. It has a few limitations:
  • It support only a limited set of columns (id, item type, name and description) since these are the only properties that are common among all items. It is also possible to display sharing information.

  • The list may have not have full support for filtering and sorting. This is due to a limitation in the query system used to generate the list.

There are also several similarities:

  • It supports all of the regular multi-item operations such as delete, restore, share and change owner.

  • Clicking on the name of the item will take you to the single-item view of that item. Holding down CTRL, ALT or SHIFT while clicking, will open the edit pop-up.

Figure 5.10. A typical list page

A typical list page

The typical list page contains the following important elements:

1. Toolbar

A toolbar with buttons for various actions such as New… for creating a new item, Delete for deleting items and Columns… for configuring columns. Depending on the permissions of the logged in user some buttons may be disabled (greyed out) or not shown at all.

2. Navigation bar

If there are many items the list will be divided into pages, each one showing a limited number of items. The navigation bar allows you to move to other pages and specify how many items each page should display. The navigation bar is repeated at the bottom of the list so you do not have to scroll back to the top of a long list just to get to another page.

3. List of presets

A list with preconfigured settings which allows you to quickly switch between different layouts (sort order, visible columns, filter settings, etc).

4. Column headers

The columns headers can be used for selecting sort order.

5. Filter bar

The filter bar allows you to search for items. Use the icon to add more filter rows.

5.4.1. Ordering the list

Most lists are by default sorted by the name of the item. This can be changed by clicking on the column header of another column. If you click on the same column twice the sort order is reversed. A downwards or upwards pointing arrow is displayed next to the column header in the column that is currently used for sorting. Column headers that are black cannot be used for sorting.

It is possible to use more than one column for sorting. Press and hold one of the CTRL, ALT or SHIFT keys while clicking on another column header. The original sorting is kept and the new column is used for sub-sorting the list. The procedure can be repeated with more columns if you need to sort on three or more columns. To revert to sort by only one column again click a column header without holding down any key.

5.4.2. Filtering the list

If the list contains many items you may need to use a filter to be able to find the item you are looking for. The input boxes on the line below the column headers are used for filtering. Most columns are filtered using a free-text input box, but some columns that can only take a few distinct values use a selection list or radio buttons instead. The selection list and radio buttons are very simple to use. Just select the alternative that you want to filter on. The list will be automatically updated when the selection has been made.

The free-text filter is a bit more complex. By default, an exact match is required, use % as a wildcard character that matches any character. For example, the filter

Experiment A

only matches the same exact string, but the filter

Exp%

matches

Experiment A, Experiment B, etc.

If you want to filter on several values at the same time, separate the values in the filter input box with the “|” character. For example, a filter text like

Experiment A|C%

matches both “Experiment A” and values that begin with “C”.

You can also use operators to find items which has a value that is greater than, less than or not equal to a specific value. This is mostly useful on numeric or date columns but also works on text columns. The operator must be entered first in the free-text box, for example

<=10

to find items which has a value less than or equal to 10. Here is a list of the supported operators:

List of operators supported by the free-text filter

<
Less than
<=
Less than or equal to
>
Greater than
>=
Greater than or equal to
=
Equal to (useful to find items with a null value). Supports filtering on more then one value.
<>, !=
Not equal to (useful to find items with a non-null value). Supports filtering on more then one value.
==
Same as = but interprets “|”, “%” and other special characters literally. Use this when you need an exact string match.
><
Within a range. Two values separated by “|” are required. For example, ><10|20 to find values between 10 and 20 (inclusive).

Extending the search with multiple filter rows

Most list pages allows you to add more than one filter row by clicking on the icon at the start of the row. Each filter row is an independent filter set that extends the search result with more items (eg. it is logically equivalent to an OR condition).

Use the icon to remove an existing filter row.

Units

Some (numeric) columns have values with units. There are, for example, the Original quantity and Remaining quantity columns for biomaterials, which have values in micrograms (µg), and annotations which may have any unit.

When filtering on a column that has a unit, numeric values without units are interpreted as the default unit for that column. But it is also possible to add a unit to the filter value. The examples below are filtering on the original quantity column of a biomaterial:

>=0.5mg

matches biomaterials with an original quantity >=500µg.

=100|200|300µg

matches biomaterials with exactly 100, 200 or 300 micrograms.

It is also possible to mix units in a single filter:

=100|200|300µg|0.5|1mg

which matches 100, 200, 300, 500 and 1000 micrograms.

[Warning] Be aware of rounding errors

All filter values with a unit that is different from the default unit are converted to the default unit before being applied. Since numeric conversions are never exact down to the last decimal, this may result in problems to filter with an exact match. The last example above could, for example, be converted to: 100, 200, 300, 500.000001 and 999.99999998.

[Tip] Hard-to-type characters

Some units contains hard-to-type characters. For example, the greek letter µ in µg, and m² and m³ for areas and volumes. In all those cases it is also possible to use ug, m2 and m3, respectively.

[Note] Units are case-sensitive

All units are case sensitive. The main reason for this is that it must be possible to tell the difference between milli (m) and mega (M) prefixes, for example, mJ and MJ.

5.4.3. Configuring which columns to show

Most lists show only a small subset of the columns it is capable of showing. There are several ways to change which columns that are visible and in which order.

  • Right-click on any column header. This will bring up a context-sensitive menu containing all possible columns. Select a column in the menu to show it. It will be inserted right after the column that was right-clicked. If the selected column is already visible it is hidden instead.

  • When hovering with the mouse inside a column header, an × is displayed in the top right corner. Click the × to hide the column.

  • It is possible to drag columns to change their order. When hovering with the mouse inside a column header, left-click the mouse and hold it. Move the mouse to another column either to the left or right and release the mouse button. The dragged column is moved to the location indicated by the black vertical bar.

  • Use the Columns… button to open a dialog (see below) that allows you to select which columns to show and the order in which they are shown. This is the most powerful way to configure the columns and includes the possibility to save a certain configuration as a preset.

Figure 5.11. Configuring which columns to show

Configuring which columns to show

Visible columns

Shows the columns that are currently visible. Use the up/down arrow buttons to arrange the order of the visible columns. The topmost column is shown to the left. Use the right arrow button to move columns from this list to the hidden columns list. Columns marked with an × are required and cannot be hidden. In most lists the Name column is the only column that is required.

Hidden columns

Shows columns that are not currently visible in the list. Use the left arrow button to move columns from this list to the visible columns list.

Presets

A dropdown list that allows you to select a set of preconfigured columns. You may also create your own preset if you often need to switch between different configurations. The list of presets is the same as the one described below, but if used from this dialog the presets only affects the visible columns and not filters or sort order.

Add inherited annotations...

Used for adding columns representing annotations that are inherited from parent items. Since a system may define a lot of different annotation types, there are no pre-defined columns that represent inherited annotations. Clicking on the buttons opens a dialog that allows you to select any annotation type that you have access to. Selected columns will be marked with [I] after their names.

[Note] Not all items can inherit annotations

This functionality is of course only available in lists that display item that can inherit annotations. For more information about inheriting annotations see Section 10.2.1, “Inheriting annotations from other items”.

Use the Save button to apply your changes or the Cancel button to close the pop-up without saving.

5.4.4. Presets

The view / presets dropdown has three main functions:

Figure 5.12. The view / presets dropdown

The view / presets dropdown

  1. Switch between different configuration presets. The top of the dropdown contains user-defined presets (Saved preset #1 and #2) and a few preconfigured presets. The user-defined presets are used to store a complete table configuration, including:

    • Which columns are visible and their order
    • The column (or columns) used for sorting
    • Filter settings
    • The number of items per page and the current page

    The preconfigured presets only affects the visible columns as follows:

    • All columns - Show all columns.

    • Required columns - Show only the required columns. Usually only the Name column is required.

    • Default columns - Show the default set of columns.

    • Other… - Open the configure columns dialog box, described in Section 5.4.3, “Configuring which columns to show”.

  2. Filter items by the removed status and the access permissions to an item.

    • Removed - If checked, items that have been moved to the trashcan are shown, otherwise they are hidden.

    • Owned by me - If checked, items that the logged in user owns are displayed, otherwise they are hidden.

    • Shared to me - If checked, items that are owned by other users but shared to the logged in user are displayed, otherwise they are hidden.

    • In current project - If checked, items that are linked with the current project are displayed, otherwise they are hidden. It does not matter if the logged in user is the owner or not. This option is only available if a project is active.

    • Owned by others - This option is only available to administrators and will display items that are owned by other users.

    The default is to display item that the current user owns and, if a project is active, items in that project.

  3. Administrate the presets

    • Clear filter - Clears all filters.

    • Save as… - Save the current configuration as a preset.

    • Manage… - Opens a dialog where you can remove saved presets. You can also load saved presets from the dialog, but it is quicker to just use the dropdown list for this.

Save a preset

If you select the Save as… option from the view / presets dropdown the Save preset as dialog is opened.

Figure 5.13. Save preset as

Save preset as

For item

The type of item the preset is saved for.

Name

The name of the preset. The name must be unique.

Overwrite existing

If a preset with the same name already exists, it is overwritten if this checkbox is checked.

Public

This options is only available for users which has the SHARE_TO_EVERYONE permission. If checked the preset is visible to all users.

Use the Ok button to save the preset or the Cancel button to close the pop-up without saving.

Manage presets

If you select the Manage… option from the view / presets dropdown the Manage presets dialog is opened.

Figure 5.14. Manage presets

Manage presets

From this dialog you can delete or load presets.

To delete presets, first mark the checkbox in front of each preset you want to delete. Then, click on the Delete… button. You will get a warning about that the action cannot be undone. Unlike other items, the presets are not moved to the trashcan. Click on Ok to delete the preset.

[Note] Edit a preset

It is not possible to edit a preset directly. To change an existing preset you must:

  1. Load the preset.
  2. Use the interface to change column settings, filter, sort order, etc.
  3. Save the preset with the same name.

Use the Close button to close the pop-up.