Feature References
A list of all the features that the viewer contains will be created here, in which the functionality of each one is explained in more detail.
General Features
Select Dataset
|
Feature Name |
Select Dataset |
Description |
A drop-down menu, which is grouped by data format. The selected dataset is
highlighted.
|
Functionality |
The drop-down menu holds all datasets available on the server. When a
new dataset is selected:
-
The first variable in the dataset is automatically selected,
or
-
If the new dataset contains a variable with the same name as the
previously selected variable, that variable will be pre-selected.
Upon dataset selection the map can pan and zoom to the extent of the
dataset. The map's zoom and pan behavior depends on the
user-defined settings.
|
Link to feature mentioned in
User Guide.
|
Locate Dataset in Map
|
Feature Name |
Locate Dataset |
Description |
Button |
Functionality |
Pans and zooms to extent of selected dataset. |
Select Variable
|
Feature Name |
Select Variable |
Description |
A drop-down menu lists all variables in the dataset, ordered according
to their sequence in the dataset.
User-defined variables
are marked with an icon and placed at the bottom of the list. The
currently selected variable is highlighted.
|
Functionality |
Displays all variables available in the dataset, along with any
user-defined variables.
|
Aim |
Enable users to easily access and switch between variables. |
Link to feature mentioned in
User Guide.
|
Show/Hide Layer Panel
|
Feature Name |
Show/Hide Layer Panel |
Description |
Button, highlighted when feature is enabled |
Functionality |
Shows or hides the
Layer Panel.
|
Aim |
Enable users to control the visibility of layers. |
Link to feature mentioned in
User Guide.
|
Layer Panel
|
Feature Name |
Layer Panel |
Description |
A draggable window displaying a list of available layers, with options
at the bottom to add user-defined basemaps or overlays. Visible layers
are marked with a checkmark, while pinned variables are indicated by a
pin icon.
This is the list of available layers in the Layers Panel:
- the selected variable
- pinned variable (marked with an icon)
- user and dataset places
- base map and overlay
- the boundary box of the selected dataset
- the RGB of both the selected and pinned dataset
|
Functionality |
Open the panel by using
the button
on the left side of the map and control the visibility of the available
layers by clicking on them in the list.
Add or modify user
variables or overlays at the bottom of the panel. Alternatively, that
can also be done in the
settings.
Close the panel by by either clicking the X or the button
again.
|
Aim |
Enable users to control the visibility of layers. |
Link to feature mentioned in
User Guide.
|
Enable Info Box
|
Feature Name |
Enable Info Box |
Description |
Button, highlighted when feature is enabled |
Functionality |
Enables the
info box.
|
Aim |
Enable users to use the info box. |
Link to feature mentioned in
User Guide.
|
|
Feature Name |
Information Box |
Description |
Displays an information box that provides pixel details for the area
being hovered over. This includes latitude, longitude, the selected
variable, and the pinned variable.
|
Functionality |
Enable the info box feature by using
the button
on the left side of the map and hover over the map to access pixel
information.
|
Aim |
Enable users to quickly access information about a pixel. |
Link to feature mentioned in
User Guide.
|
Compare Variables
Pin Variables
|
Feature Name |
Pin Variable |
Description |
Button that is highlighted when the currently selected variable is the
pinned variable.
|
Functionality |
Click the button to pin a variable. When a variable is pinned, the
split mode for
visual comparison is automatically activated, if it hasn't been opened
yet.
A variable can be unpinned by clicking the button again.
If the variable should remain pinned but the split mode should be
closed, the
split mode button
must be clicked.
|
Aim |
To pin variables for comparison. |
Link to feature mentioned in
User Guide.
|
Split Mode
|
Feature Name |
Split Mode |
Description |
A button, highlighted when the function is enabled. When the mode is
activated, the screen is divided in the middle by a slidable line.
|
Functionality |
Start the comparison mode by using the button. The map is now split in
the middle and the currently selected variable is
displayed on the right side of the slidable line. If a
variable is pinned, it is displayed on the
left side of the screen along with its color bar.
The slidable line allows users to shift the view, enabling spatial
comparison with underlying layers (e.g. basemaps, the pinned variable).
The variable on the left can be made transparent to enhance the
comparison.
Side note: The comparison mode is automatically
activated when a variable is
pinned.
|
Aim |
Enables visual comparison of the selected variable with another (pinned
variable) or with other layers, such as a user basemap or dataset RGB.
|
Link to feature mentioned in
User Guide.
|
User Variables
Open User Variable Management
|
Feature Name |
Open User Variable Management |
Description |
A button that opens a window for
managing user variables.
|
Aim |
To open user variable management menu. |
Link to feature mentioned in
User Guide.
|
User Variable Management
|
Feature Name |
User Variable Management |
Description |
A window for managing user variables, that displays a list of all
existing user variables, including their name, title, units, and
expression. It also contains various buttons for managing user
variables, as well as a button that opens an informational text
regarding user variables.
|
Functionality |
Open the User Variable Management menu with
this button
in order to manage user variables with the following features:
When no variable is selected:
When a user variable is selected:
-
Add User Variable: To open a new window to create a user variable.
-
Duplicate User Variable: To duplicate the selected
variable, appending
_copy to the title of the
duplicate.
-
Edit User Variable: To open a window similar to the Add User Variable window for
editing the selected variable.
-
Remove User Variable: To remove the variable from the
list.
|
Aim |
To manage user variables. |
Link to feature mentioned in
User Guide.
|
Add User Variable
|
Feature Name |
Add User Variable |
Description |
A window that opens using the + -button in the User Variables
Management menu. The window contains input fields for
name, title, units, and expression. There is also an option to display
various optional components of the expression.
|
Functionality |
Open this feature by using the
+ -button in the User Variables Management menu and fill in the fields to
create a new variable.
To successfully add a variable, a valid
name
and a valid
python expression
must be provided. title and units are optional fields.
-
The name must be a unique identifier within the User
Variables and must start with a letter.
-
The expression is an algebraic expression that
follows the syntax of python expressions.
|
Aim |
To add user variables. |
Link to feature mentioned in
User Guide.
|
Edit User Variable
Feature Name |
Edit User Variable |
Description |
A window that opens using the Edit -button in the User
Variables Management menu. For layout see
add user variables.
|
Functionality |
See
add user variables.
|
Aim |
To edit user variables. |
Link to feature mentioned in
User Guide.
|
|
Feature Name |
Metadata |
Description |
Positioned in the sidebar, the metadata for the
selected dataset, variable, or place is located under
the "Info"-Tab. The display can be enabled using the
buttons at the top left. When a display is enabled, the button's
background appears highlighted in gray.
Next to the displayed metadata information, three additional buttons
control the format of the metadata display. Depending
on the selected format, the enabled button's background is highlighted in
gray.
|
Functionality |
Open the sidebar and navigate to the "Info" tab to view the metadata.
Enable the display for the object of interest: dataset, selected
variable, or selected place. If no place is currently selected, the most
recently selected place will be used. Then, choose the relevant metadata
format:
-
Textual: A summary of properties in a
human-readable format.
-
Tabular: A complete list of attributes presented in
a table.
-
JSON: All attributes shown as machine-readable
JSON.
|
Aim |
To provide metadata information for the dataset, the selected variable,
or the selected place.
|
Link to feature mentioned in
User Guide.
|
|
Time Series
Add Time Series
|
Feature Name |
Add time series/ Show time-series diagramm |
Description |
A button in the top toolbar with a graph icon, initially disabled. It
becomes available only when a place is selected.
|
Functionality |
A place must be selected for the feature to work. If not already
open, the sidebar will open upon using this feature, displaying the time
series data for the selected place. If no data is available for the
selected place, an informational pop-up window displays the message:
No information data found here along with a warning. And
no time series will be added to the diagram.
|
Aim |
Create a time series for the selected variable of a selected place.
|
Link to feature mentioned in
User Guide.
|
Add Initial Time Series
|
Feature Name |
Initial Time Series |
Description |
The space under the "Time Series" tab in the sidebar varies depending on
whether a time series graph is present. If no time series graph exists:
A message indicates that no time series is currently displayed. Additionally
a button in the header is also available, which becomes active (with blue
font color) when a variable and place are selected and it is possible to
create a time series.
|
Functionality |
Open the sidebar and navigate to the "Time Series". Select a place and a
variable, then click the button to display a time series. Alternatively,
the time series can be created using
the button in the header.
|
Aim |
To create the initial time series graph for a selected place and
variable in the sidebar.
|
Link to feature mentioned in
User Guide.
|
Navigate Time Series Graphs
|
Feature Name |
Navigate Time Series Graphs |
Description |
A time series graph is displayed in the sidebar under the "Time Series"
tab. Time series extracted from the same variable are displayed in a
combined plot, allowing for easy comparison. A slider located at the top
of the section to controll the displayed time range. Additionally,
several features for navigating through the time series plot are
conveniently positioned at the top right of the graph. The places for
which time series have been extracted are listed below each plot,
displaying the place name and coordinates if they are points.
|
Functionality |
Open the sidebar and navigate to the "Time Series".
-
Remove time series graphs of places by clicking the
- -
button located below the plot next to the respective place. (h)
- Adjust the time range to focus on a specific period of interest.
This applies to time series of different variables within a
dataset (a)
- Additionally, enable the buttons on the top right to:
- Reset everything back to the full scale (b)
- Zoom into the graph freely by pressing the Ctrl-key (c)
- Set a fixed y-scale for the graph (d)
-
Hover over the graph to view detailed information for specific
time steps via a popup info box (e)
-
Display data with points, lines, or bars. For polygons or circles,
you can also add the standard deviation to the graph (f)
- Copy a snapshot a time series to clipboard (g)
|
Aim |
To provide a range of functions for investigating time series data.
|
Link to feature mentioned in
User Guide.
|
Statistics
Statistics Overview
|
Feature Name |
Statistics Overview |
Description |
This tab, located in the sidebar, lists all generated statistics with
the most recent ones at the top. When a variable and place are selected,
an option to generate statistics for them appears above the list of
existing statistics. This option becomes active once a place is
selected.
|
Functionality |
Open the tab in the sidebar and add new statistics with the
+ -button and remove statistics using the
x -button.
|
Aim |
To provide a dedicated space to display, generate, and manage
statistics.
|
Link to feature mentioned in
User Guide.
|
Add Statistics
|
Feature Name |
Add Statistics |
Description |
A button in the top toolbar with a graph icon, initially disabled. It
becomes active only when a location is selected.
|
Functionality |
A place must be selected for the feature to work. If not already open,
the sidebar will open upon using this feature, displaying the statistics
for the selected place. If no data is available for the selected place,
an informational pop-up window displays the message:
No information data found here along with a warning. An
empty table is shown in this case.
|
Aim |
Create statistics for the selected variable of a selected place. |
Link to feature mentioned in
User Guide.
|
Statistics Display - Points
|
Feature Name |
Statistics Display Points |
Description |
Located in the Statistics-tab, a table displays the
value at the selected point's coordinates for the selected variable.
Above the table, details are shown, including the dataset, variable,
time step, and place name.
|
Functionality |
Open the tab in the sidebar and add new statistics with the
+ -button and remove statistics using the
x -button.
|
Aim |
To display statistical information for places of type Point . |
Link to feature mentioned in
User Guide.
|
Statistics Display - Polygons/Circles
|
Feature Name |
Statistics Display Polygons/Circles |
Description |
Located in the Statistics-tab, a table provides
statistical values, including pixel count, minimum, maximum, mean, and
standard deviation. A histogram displays these values, using the color
associated with the place. Features to explore the statistics include:
- Adjust the x-range of the histogram (a)
- Add the standard deviation to the histogram (b)
- Copy a snapshot of the statistics to clipboard (c)
|
Functionality |
Open the tab in the sidebar and add new statistics with the
+ -button and remove statistics using the
x -button. Then, use the mentioned features to explore and
work with the statistics
|
Aim |
To display and explore statistical information for places of type
Polygon or Circle .
|
Link to feature mentioned in
User Guide.
|
Places
Select Place Group
|
Feature Name |
Select Place Group |
Description |
A drop-down menu that lists place groups available on the server, along
with a My Places group that contains all the places created
in the Viewer. A selected group is marked with a checked checkbox and
highlighted background.
|
Functionality |
Select one or multiple groups in the drop-down menu by clicking on their
names, which will be marked with a checkmark in the checkbox to display
them on the map.
Side note: Selecting a group does not automatically
adjust the map's view to the extent of the place group.
|
Aim |
Manage visibility of place groups. |
Link to feature mentioned in
User Guide.
|
Select Place
|
Feature Name |
Select Place |
Description |
A drop-down menu that contains a list of all places within the selected
place groups. The selected place is highlighted in the list.
|
Functionality |
Select a place by clicking on it in the list. The selected place will be
visually highlighted on the map with a yellow outline. The map
automatically pans and zooms to the selected place, if selected in the
settings.
|
Aim |
Select and focus on a specific place. |
Link to feature mentioned in
User Guide.
|
Select Place in Map
|
Feature Name |
Select Place in Map |
Description |
A button that is highlighted when enabled. |
Functionality |
Select a place by clicking on it directly in the map. The selected place
will be visually highlighted on the map with a yellow outline.
|
Aim |
Select a place directly in the map. |
Link to feature mentioned in
User Guide.
|
Rename Place Group/ Place
|
Feature Name |
Rename Place Group/ Place |
Description |
A button located next to the drop-down menu. |
Functionality |
Provides the option to rename the selected place or place group.
Important: Only place groups created within the
Viewer and their associated places can be renamed.
|
Aim |
Rename a place group or individual place. |
Link to feature mentioned in
User Guide.
|
Remove Place Group/ Place
|
Feature Name |
Remove Place Group/ Place |
Description |
A button located next to the drop-down menu. |
Functionality |
Removes the selected place or place group.
Important: Only place groups created within the
Viewer and their associated places can be removed.
|
Aim |
Remove a place group or individual place. |
Link to feature mentioned in
User Guide.
|
Style Place
|
Feature Name |
Style Place |
Description |
A button that opens a small window for adjusting color and opacity.
When clicking on the color box, a drop-down menu with a variety of
colors appears. The opacity is controlled with a slider.
|
Functionality |
Adjust the appearance (color and opacity) of the selected place in the
window that appears when clicking the button. The changes are
immediately reflected on the map. The selected color also determines the
representation of points in time series chart.
|
Aim |
Change the appearance of a place. |
Link to feature mentioned in
User Guide.
|
Locate Place in Map
|
Feature Name |
Locate Place in Map |
Description |
A button located next to the selection of places. |
Functionality |
Pans and zooms to the selected place on the map. |
Aim |
Locate the selected place on the map. |
Add Place
|
Feature Name |
Create Place |
Description |
A button that is highlighted when enabled. |
Functionality |
Click on one of the three buttons to create a new place directly in the
map. The available geometry types are: Point ,
Polygon , and Circle . The newly created place
is automatically set as the selected place. The names of places are
chosen according to their geometry type and order, e.g.,
Circle 1 .
When creating a new place, a time series for the selected variable is
created and displayed in the side bar automatically. If no data is
available for the new place in the dataset, a pop-up window appears with
the message:
No information data found here .
Side note: When the feature is disabled,
the
Select place in map
mode is automatically enabled.
|
Aim |
Create a place directly in the map. |
Link to feature mentioned in
User Guide.
|
Import Places
|
Feature Name |
Import Places |
Description |
A button that is highlighted when enabled and opens a window for
importing places. In the window Supports importing places in various
formats, including text/CSV, GeoJSON, and WKT.
|
Functionality |
Open the feature by clicking on the button, then:
-
Decide on the data format of the imported places (text/CSV, GeoJSON,
or WKT)
-
Import places through different methods:
-
Open from file: Opens a window to browse and
select a file locally.
-
Enter text: Manually input data into a text
box.
-
Drag & drop: Drag a file into the designated
area to load it into the text box.
-
Remove the content of the text box with the
Clear-button. This is only available when the box
contains data.
-
Options-button: Can be expanded to provide
additional information and settings related to the import process.
|
Aim |
Enable import of places from various sources, making it easier to manage
and display custom places within the Viewer.
|
Link to feature mentioned in
User Guide.
|
|
Feature Name |
Open Export Data Menu |
Description |
A button that opens the
Export Data menu.
|
Aim |
To open the Export Data menu. |
Link to feature mentioned in
User Guide.
|
Export Data
|
Feature Name |
Export Data |
Description |
A pop-up window that provides options for configuring the export
settings for time series and place geometries.
|
Functionality |
Open the export settings by using
this button
in the header of the Viewer and select options for export:
-
Include time series data (file format:
.txt )
-
Separator for time series data (default:
, )
-
Include place data (file format:
.geojson )
- Combine place data into a single file
- Export as a ZIP archive
- Filename configuration
|
Aim |
To export places and/or time series created within the Viewer. |
Link to feature mentioned in
User Guide.
|
Navigate Time Steps
Select Time Steps (Calender)
|
Feature Name |
Select Time Step (Calender) |
Description |
A button that opens a calendar window when enabled. |
Functionality |
The button opens a calendar window when clicked. Click on a date in the
calendar, to select and display the time step that is closest to the
chosen date.
The time resolution (HH:MM:SS) is not supported yet, but it will be
displayed in the calendar view if the resolution is available in the
dataset.
|
Aim |
Easily navigate and select specific time steps within a dataset using a
visual calendar interface.
|
Link to feature mentioned in
User Guide.
|
Select Time Steps (Slider)
|
Feature Name |
Select Time Step (Slider) |
Description |
A time slider to navigate through the time steps of the selected
variable. The slider is labeled with the first and last time steps of
the dataset at the start and end points.
|
Functionality |
Move the slider to select and display the desired time step. |
Aim |
Easily navigate and explore time steps within a dataset. |
Link to feature mentioned in
User Guide.
|
+/- 1 Time Step
|
Feature Name |
Move to +/- 1 Time Step |
Description |
Buttons, designed according to its function, allowing to navigate to
either the previous or next time step of the dataset.
|
Functionality |
Click the buttons to move to the previous/next time step in the dataset
and display the corresponding data on the map.
|
Aim |
Quick navigation option to access the previous and next time steps in
the dataset.
|
Link to feature mentioned in
User Guide.
|
First/Last Time Step
|
Feature Name |
Move to first/last Time Step |
Description |
Buttons, designed according to its function, allowing to navigate to
either the first or last time step of the dataset.
|
Functionality |
Click the buttons to move to the first/last time step in the dataset and
display the corresponding data on the map.
|
Aim |
Quick navigation option to access the first and last time steps in the
dataset.
|
Link to feature mentioned in
User Guide.
|
Auto-step
|
Feature Name |
Auto-step |
Description |
A button that changes its appearance when the feature is activated,
while disabling the buttons used to navigate through time steps.
|
Functionality |
When enabled, the feature iterates through the time steps sequentially,
displaying each step in the Viewer. The speed or interval of this
iterating can be configured in the settings. Click the button again to
pause.
|
Aim |
Engaging way to visually explore multiple time steps. |
Link to feature mentioned in
User Guide.
|
Color Mapping
Legend
|
Feature Name |
Legend |
Description |
Displays the current color map, the value range, and the long name of
the variable along with its units (these details are extracted from the
dataset). The color mapping is selected automatically based on the
configuration in xcube Server. The value range and color bar are hidden
buttons, providing access to adjust the value range and
color map.
|
Functionality |
The legend is interactiv:
|
Aim |
Display the color mapping of the current variable and provide access
to further adjustments regarding the color mapping.
|
Link to feature mentioned in
User Guide.
|
Value Range
|
Feature Name |
Adjust Value Range |
Description |
A window that opens when clicking on the value range of the color bar in the legend,
to adjust the settings of the value range.
This includes:
-
A slider to manually adjust the
minimum and maximum values.
-
Text fields to enter minimum and maximum values.
-
A toggle button on the top-right corner to enable
log-scaling.
-
A toggle button for applying the value range of the color map. This
feature is only available if the color map has an
assigned value range.
|
Functionality |
Open the feature by clicking on the legend area where the value ticks
are shown. Then use the available features to adjust the edges of the
value range, to use a log-scaling or to apply the assigned value range
of the color map.
|
Aim |
Adjust the value range of the current color mapping .
|
Link to feature mentioned in
User Guide.
|
|
Feature Name |
Color Map Menu |
Description |
A window that opens when clicking on the color bar in the legend. This
menu provides:
- access to custom colormap management
- a list of already available color maps
- options for hiding small values (button)
- options for adjusting opacity (slider)
- options for reversing the color map (button) (button)
|
Functionality |
Open the menu by clicking on the colormap in the legend. Then use the
menu to access
custom colormap management, select new colormaps or adjust the currently selected.
|
Aim |
Manage custom color maps, change, adjust and modify the current color
mapping.
|
Link to feature mentioned in
User Guide.
|
Custom Color Maps
|
Feature Name |
Custom Color Maps |
Description |
A small workspace that appears when clicking the + -button
in the Color Mapping Menu or when editing an existing custom color map.
Displayed at the top is the color bar, then there is the option to
select the color map type followed by a text field where users can
define or edit the color map.
|
Functionality |
Access the Custom Color Map workspace by using the + -button
in the
Color Mapping Menu
or entering the editing mode for custom color maps. In the workspace:
-
Decide on the color mapping type (continious, stepwise,
categorical).
-
In the text box, define the mapping using the general syntax
<value>: <color> .
|
Aim |
Select, create, edit or delete custom color maps. |
Link to feature mentioned in
User Guide.
|