Skip to content

Commit

Permalink
Update documentation for charts in user manual (#1916)
Browse files Browse the repository at this point in the history
* Add documentation that describes basic chart features new with Plotly JS. 
* Add documentation about Metric Explorer chart features (context menus for different chart elements)
  • Loading branch information
aestoltm authored Dec 2, 2024
1 parent d5516bc commit b29a5ac
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 0 deletions.
21 changes: 21 additions & 0 deletions user_manual_builder/Common_User_Interface_Elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,27 @@ the chart. The chart shown in :numref:`chart_viewer` is from the
Resource* category is expanded, followed by selection of the *XD SUs
Charged: Per Job* metric.

Every chart in XDMoD can zoom along a specific axis by clicking and dragging
the cursor in a straight line vertically or horizontally to zoom along the
y-axis or x-axis, respectively. When adjusting the zoom along a specific axis
you will be able to adjust the range of the data based on how far you drag
your cursor. Every chart in XDMoD can also zoom along both the x- and y-axes
adjusting the range for both. For most charts in XDMoD, the zoom level can
be reset by double clicking on an empty area of the plot. The only exception
is for charts in the :ref:`Metric Explorer <metric_explorer>` tab, where you
can reset the zoom by clicking on the chart and choosing the "Reset Zoom"
option from the context menu.

.. figure:: media/plot_vertical_zoom.png
:name: plot_vertical_zoom

Example of adjusting the zoom along the y-axis (vertically).

.. figure:: media/plot_horizontal_zoom.png
:name: plot_horizontal_zoom

Example of adjusting the zoom along the x-axis (horizontally).

Drilldowns: Most of the charts displayed in XDMoD have a drill-down
capability, which will allow users to click on a data series (bar, line,
pie slice, etc.) and acquire more detailed information about the
Expand Down
43 changes: 43 additions & 0 deletions user_manual_builder/Metric_Explorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,49 @@ display format.

In the Metric Explorer Plots can easily be changed directly by clicking on them.

Additional Chart Features
-------------------------
Clicking on a y-axis label will open a dialog box next to the clicked label.
Through this dialog box you can adjust the minimum and maximum values of the
range for any of the y-axes on the plot. You can reset these values by
clicking on the "Reset Range" button or by erasing the values. Additionally,
you can enable a logarithmic scale for that y-axis.

.. figure:: media/metric_explorer_yaxis_context_menu.png
:name: metric_explorer_yaxis_context_menu

You can adjust the range and enable a log scale by clicking on a
y-axis label.

Clicking on an x-axis label will open a dialog box next to the clicked label.
Through this dialog box you can adjust the time duration for the chart.
The options available replicate the duration toolbar.

.. figure:: media/metric_explorer_xaxis_context_menu.png
:name: metric_explorer_xaxis_context_menu

You can adjust the time duration by clicking on an x-axis label.

Clicking on a legend entry will open a dialog box next to the clicked entry.
The context menu provided through the legend entry is the same as clicking on
a point in the plot. The only option that is excluded is the "Show Raw Data" option.

.. figure:: media/metric_explorer_legend_context_menu.png
:name: metric_explorer_legend_context_menu

You can interact with a data series context menu by clicking on its
respective legend entry.

For Metric Explorer charts, the zoom level of the plot is reset differently
than the other tabs. The zoom level can be reset by clicking on the chart
and choosing the "Reset Zoom" option from the context menu.

.. figure:: media/metric_explorer_reset_zoom.png
:name: metric_explorer_reset_zoom

You can reset the zoom level of a chart by clicking on it and
choosing "Reset Zoom."

Managing Data Series
-------------------------

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 user_manual_builder/media/plot_vertical_zoom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b29a5ac

Please sign in to comment.