Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Documentation is updated regarding the sorting and filtering in the sample and reaction list #308

Merged
merged 1 commit into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions docs/eln/ui/lists.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,36 @@ Thus, the image representing the molecule (and therewith the samples) changes if

The list of samples contains further information.

### Sorting of the samples list
### Filtering of the sample list

Filtering can be done according to a date, filtering the lists using structure search or text search.

This option does not sort the sample list. It only sets a parameter for filtering and the filtering will be done based
on the specified date range in the From and To fields.

When it shows `currently filtered by creation date` then it will show all the entries that were created in the specified
date range.

Similarly when it shows `currently filtered by update date` then it will show all the entries that were updated in the
specified date range.

![sample_filtering](/img/sample_filtering.gif)

Sorting can be done by filtering according to a date, filtering the lists using structure search or text search.
To be continued...

### Sorting of the sample list

Currently, the sample list is sorted by the updated date, by default. It is in our <u>ToDo</u> to implement the
option to sort this list based on various other parameters, like creation date, etc.

## Lists for reactions
Initially, the reaction list will remain sorted by the descending order of creation date.

### Sorting of the reaction list

It is possible to sort the reaction list based on various parameters. Initially, it is sorted by the descending order
of creation date, which, later on, can be changed to update date. The sorting direction can also be changed to
ascending or descending order. Additionally, when the reaction list has been
[grouped](elements/grouping#reaction-grouping), then the list can be further sorted by RInChI, reaction type, etc.

![reaction_sorting](/img/reaction_sorting.gif)
Binary file added static/img/reaction_sorting.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/sample_filtering.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.