Skip to content

Commit 2eaffa0

Browse files
committed
website: quickview - variable selection and viewport layout
1 parent 10ad791 commit 2eaffa0

6 files changed

Lines changed: 83 additions & 15 deletions

docs/guides/quickview/file_selection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ The user can now start to search for and load variables to inspect.
3737

3838
![File loaded](./screenshots/file_loaded.png){ width="95%", align=center }
3939

40+
::: tip Tip: File system navigation
41+
:::
42+
4043
::: tip Tip: Loading a file series from the same simulation
4144
:::
4245

3.03 MB
Loading
2.86 MB
Loading
2.78 MB
Loading

docs/guides/quickview/variable_selection.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,56 @@
22

33
QuickView's capabilities of variable search and selection
44
has been enhanced substantially compared to the earlier version.
5-
The enhancement was motivated partly by the generalization of
6-
the tool to handle arbitrarily shaped arrays defined on the cubed sphere,
7-
and partly due to the wish to help users navigate through simulation
5+
The enhancement was partly motivated by the generalization of
6+
the tool to handle arbitrarily-shaped arrays,
7+
and partly due to the intention to help users navigate through simulation
88
files containing many (e.g., hundreds of) variables.
9-
Here, we use a file with more than one thousand variables as an example
9+
10+
Here, we use a simulation file with more than one thousand variables as an example
1011
to explain the search and selection capabilities.
1112

12-
<!-- ![File loaded](./screenshots/variables_none_or_all.png){ width="95%", align=center } -->
13+
## Checkboxes for selecting and unselecting variables
1314

1415
![File loaded](./screenshots/variable_list_none_selected.png){ width="55%", align=right }
15-
The first screenshot shows the Variable Selection panel
16+
The first screenshot here shows the Variable Selection panel
1617
right after the files have been loaded.
1718
- The checkboxes to the left of each variable name can be used
1819
to select or unselect the corresponding variables.
1920
- The first checkbox, to the left of "Name" and below the eye icon,
2021
can be used to select or unselect all variables.
2122

23+
## Variable proups
24+
2225
![File loaded](./screenshots/variable_list_all_selected.png){ width="55%", align=right }
23-
When all variables are selected using the first checkbox, we get the second screenshot shown here.
26+
QuickView sorts variables into different groups according to their dimensions
27+
and allows the users to select, unselect, and inspect groups.
28+
29+
In the same example as discussed above, when all variables are selected
30+
using the first checkbox in the Variable Selection control panel,
31+
we get the second screenshot shown here.
2432
- The **wide blue button** at the top of the contol panel indicates there is
2533
a total of 1385 variables displayable in the file.
26-
- The **colorful tabs** correspond to different variable shapes (dimension
27-
combinations). The different cominations, as well as the number
28-
of displayable variables in each group, are shown in the tabs.
29-
Each tab has a close button that can be used to unselect the entire group.
34+
- The **colorful tabs** correspond to different variable groups with distinct shapes.
35+
Each groups shape (dimension combination), as well as the number
36+
of displayable variables in the group, is shown in the corresponding tab.
37+
Each tab also has a "close" button that can be used to unselect the entire group.
3038

3139
Note that at this point, QuickView has *not* loaded all the variables into memory.
3240
It has finished a scan and *is ready to load* these variables.
3341

42+
## The filter box
3443

35-
Additional talk points:
44+
Talk points to be expanded after we further revise the filter logic:
3645

3746
- filter box; filter by dimension name, dimension combination, or variable name
3847
- eye icon: cycle through lists of selected, unselected, and all variables in the filtered list.
39-
- clicking on a tab applys filter by shape combination.
40-
- close button in filter box clears filter (make cross always visible)
41-
48+
- clicking a tab will filter the list of all variables by the shape combination.
49+
- filter is applied immediately when contents are entered.
50+
- implication: when the filter box is not empty, the eye icon and the first checkbox
51+
will operate on the filtered list. If the user wants them to apply to the full list
52+
of displayable variables instead, then the filter box should be cleared by deleteing the
53+
text; a shortcut would be to use the "close button" that shows up when the cursor
54+
hoves over the filter box".
55+
56+
::: warning Reminder: Use the `Load X variables` button to apply selection or change
57+
:::
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
11
# Customizing Viewport Layout
2+
3+
::: For users of QuickView version 1
4+
QuickView version 1 allowed the user to change the size and sequence
5+
of different views (map plots) in the viewport by drag-and-drop.
6+
Users' feedback indicated that arbitrary drag-and-drop can get confusing,
7+
and it was inconvenient to not having a way to reapply the same size to all views.
8+
With these comments in mind, we have changed the mechanisms for
9+
configuring the viewport in version 2.
10+
:::
11+
12+
## View size
13+
14+
QuickView version 2 supports showing 1, 2, 3, 4, or 6 columns of views (map plots)
15+
in the view port. The number of columns can be changed by pressing the desired number
16+
on the keyboard or using the Viewport Layout control panel, via the "Size" menu
17+
on the right of that panel, as shown in the screenshot below.
18+
19+
The viewport is evenly divided into the selected number of columns.
20+
When the user adjusts the size of their browser window, the
21+
sizes of the map plots will be automatically adjusted to fit into the adjusted browser window.
22+
23+
![Viewport column size](./screenshots/viewport_with_column_size_menu.png){ width="95%", align=center }
24+
25+
## Grouped or ungrouped views
26+
27+
If the user has selected and loaded variables of different shapes,
28+
then, by default, the viewport will present the map plots in groups.
29+
For each group, a vertical bar, shown in the same color as the group tab
30+
in the Variable Selection control panel, is shown on the left side of
31+
the viewport to distinguish the group.
32+
The screenshot above shows 3 variable groups.
33+
34+
This grouping in the viewport can be canceled (or reapplied) by using
35+
the `G` key or a "Grouped" versus "Ungrouped" toggle.
36+
37+
## Variable sequence
38+
39+
In the top-left corner of each individual view, the variable name is shown.
40+
Clicking the text will activate a drop-down menu for the user to replace
41+
the current variable by a different one.
42+
43+
If the plots in the viewport are ungrouped, the drop-down menu will
44+
list all the other variables that have been loaded. See example
45+
in the screenshot below.
46+
47+
If the plots in the viewport are grouped, the drop-down menu will
48+
list all the other loaded variables *in the same group*.
49+
50+
![Select variable for a view](./screenshots/variable_selection_in_viewport_when_ungrouped.png){ width="95%", align=center }

0 commit comments

Comments
 (0)