Skip to content

Commit 68f2eaf

Browse files
authored
fix(ui): improve wording
* ui: reword 'full grid' to 'viewport' * ui: reword 'Uniform' to 'Ungrouped' in viewport control panel - resolve conflict with master * ui: change key bindings for state import/export: replace U/D by I/E
1 parent a3cdee3 commit 68f2eaf

7 files changed

Lines changed: 21 additions & 15 deletions

File tree

docs/guides/dev/what_is_where.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Key bindings
2+
3+
- Defined in `src/e3sm_quickview/app.py`. Look for `mt.bind`
4+
- Hints in drawers: `src/e3sm_quickview/components/tools.py`. Look for `keybinding=`.
5+
6+
- Hints on landing page: `src/e3sm_quickview/components/doc.py`. Look for `keys=`.

docs/guides/quickview/file_selection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ users launch QuickView in a directory close to their data.
5858

5959
The current state of the analysis session can be saved—and reloaded later to resume
6060
the analysis—using the `State Import/Export` button in the vertical toolbar
61-
or using the shortcut `D` for download and `U` for upload.
61+
or using the shortcut `I` for import and `E` for export.
6262

6363
Note that regardless of whether QuickView is executed on a local computer
6464
or on a remote system (e.g., at NERSC), the state files are saved to and uploaded from the local computer.

docs/guides/quickview/miscellaneous.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ or animations for presentations and manuscripts, etc.:
4545
change in that dimension, the user can click on the icon on the right end of the
4646
animation control panel, i.e., the downward arrow with two lines,
4747
to bring up a drop-down menu and then click to select
48-
`Full grid` and/or individual variables. Subsequently, a click on `Export animation`
48+
`Viewport` and/or individual variables. Subsequently, a click on `Export animation`
4949
triggers QuickView to scan through the indices in the `lev` dimension,
5050
with a dark-red circle spinning around the download button while the scan is in progress.
5151
After the scan is finished, a file `quickview-animation.zip` gets downloaded to the local computer.

src/e3sm_quickview/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ def _build_ui(self, **_):
182182
mt.bind("m", "ProjectionMollweide")
183183

184184
mt.bind("f", "FileOpen")
185-
mt.bind("d", "SaveState")
186-
mt.bind("u", "UploadState")
185+
mt.bind("e", "SaveState")
186+
mt.bind("i", "UploadState")
187187
mt.bind("h", "ToggleHelp")
188188

189189
mt.bind("p", "ToolbarLayout")

src/e3sm_quickview/components/doc.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ class ToolStateImportExport(Tool):
5959
def __init__(self):
6060
super().__init__(
6161
icon="mdi-folder-arrow-left-right-outline",
62-
title="State import/export",
63-
description="Export the application state into a small text file. The same file can then be imported to restore that application state.",
62+
title="State export/import",
63+
description="Export and download the application state into a small text file. The same file can then be uploaded and imported to restore that application state.",
6464
)
6565
with self, v3.Template(v_slot_append=True):
66-
v3.VHotkey(keys="d", variant="contained", inline=True)
67-
v3.VHotkey(keys="u", variant="contained", inline=True)
66+
v3.VHotkey(keys="e", variant="contained", inline=True)
67+
v3.VHotkey(keys="i", variant="contained", inline=True)
6868

6969

7070
class ToolMapProjection(Tool):
@@ -249,14 +249,14 @@ def __init__(self):
249249
v3.VHotkey(keys="f", variant="contained", inline=True)
250250

251251
with v3.VRow(classes="ma-0 pb-4"):
252-
v3.VLabel("Download state")
252+
v3.VLabel("Export state")
253253
v3.VSpacer(classes="mt-2")
254-
v3.VHotkey(keys="d", variant="contained", inline=True)
254+
v3.VHotkey(keys="e", variant="contained", inline=True)
255255

256256
with v3.VRow(classes="ma-0 pb-4"):
257-
v3.VLabel("Upload state")
257+
v3.VLabel("Import state")
258258
v3.VSpacer(classes="mt-2")
259-
v3.VHotkey(keys="u", variant="contained", inline=True)
259+
v3.VHotkey(keys="i", variant="contained", inline=True)
260260

261261
v3.VDivider(classes="mb-4")
262262

src/e3sm_quickview/components/toolbars.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ def __init__(
189189

190190
# --- Grouped/Uniform toggle ---
191191
v3.VCheckbox(
192-
v_tooltip_bottom="layout_grouped ? 'Switch to uniform' : 'Switch to grouped'",
192+
v_tooltip_bottom="layout_grouped ? 'Switch to ungrouped' : 'Switch to grouped'",
193193
v_model=("layout_grouped", True),
194194
hide_details=True,
195195
inset=True,
@@ -670,7 +670,7 @@ def __init__(self):
670670
activatable=True,
671671
active_strategy="independent",
672672
):
673-
v3.VListItem(title="Full grid", value=("false",))
673+
v3.VListItem(title="Viewport", value=("false",))
674674
v3.VDivider()
675675
v3.VListItem(
676676
v_for="name in variables_selected",

src/e3sm_quickview/components/tools.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ class CaptureFullPanel(ActionButton):
8787
def __init__(self, compact="compact_drawer", click=None):
8888
super().__init__(
8989
compact=compact,
90-
title="Capture full grid as png",
90+
title="Capture viewport as png",
9191
icon="mdi-camera-outline",
9292
click=click,
9393
)

0 commit comments

Comments
 (0)