Update documentation for charts in user manual #1916
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aestoltm
requested review from
eiffel777,
jpwhite4,
ryanrath,
aaronweeden and
connersaeli
aaronweeden
requested changes
Nov 25, 2024
| @@ -388,6 +388,21 @@ origin of the chart. | |||
|
|
|||
| Example of a drilldown chart | |||
|
|
|||
| Every chart in XDMoD can zoom along a specific axis by click and dragging the cursor vertically or horizontally to zoom by the y-axis and x-axis, respectively. | |||
There was a problem hiding this comment.
I would suggest moving this new section above the drilldown section since it is more general.
| @@ -388,6 +388,21 @@ origin of the chart. | |||
|
|
|||
| Example of a drilldown chart | |||
|
|
|||
| Every chart in XDMoD can zoom along a specific axis by click and dragging the cursor vertically or horizontally to zoom by the y-axis and x-axis, respectively. | |||
There was a problem hiding this comment.
Suggested change
| Every chart in XDMoD can zoom along a specific axis by click and dragging the cursor vertically or horizontally to zoom by the y-axis and x-axis, respectively. | |
| 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. |
| Every chart in XDMoD can zoom along a specific axis by click and dragging the cursor vertically or horizontally to zoom by the y-axis and 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 axis 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 are charts in the Metric Explorer tab (see :ref:`Metric Explorer <metric_explorer>`). |
There was a problem hiding this comment.
Suggested change
| The only exception are charts in the Metric Explorer tab (see :ref:`Metric Explorer <metric_explorer>`). | |
| 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. |
| @@ -211,6 +211,50 @@ display format. | |||
|
|
|||
| In the Metric Explorer Plots can easily be changed directly by clicking on them. | |||
|
|
|||
| Basic Chart Features | |||
There was a problem hiding this comment.
Suggested change
| Basic Chart Features | |
| Additional Chart Features |
Comment on lines
217
to
219
| The chart y and x axis have context menus that allow you to adjust the range and duration, respectively. | ||
| The chart legend entries can be used to access the data series context menu, | ||
| similar to clicking on the data series in the chart itself. |
There was a problem hiding this comment.
I would remove these summary sentences since they don't add additional information and it wasn't fully clear to me what they meant until I saw the screenshots later.
|
|
||
| You can adjust the range and enable log scaling by clicking on a y-axis label. | ||
|
|
||
| Clicking on a x-axis label will open a dialog box next to the clicked label. |
There was a problem hiding this comment.
Suggested change
| Clicking on a x-axis label will open a dialog box next to the clicked label. | |
| Clicking on an x-axis label will open a dialog box next to the clicked label. |
| You can adjust the range and enable log scaling by clicking on a y-axis label. | ||
|
|
||
| Clicking on a x-axis label will open a dialog box next to the clicked label. | ||
| Through this dialog box you can adjust the time duration set for the chart. |
There was a problem hiding this comment.
Suggested change
| Through this dialog box you can adjust the time duration set for the chart. | |
| Through this dialog box you can adjust the time duration for the chart. |
| .. figure:: media/metric_explorer_xaxis_context_menu.png | ||
| :name: metric_explorer_xaxis_context_menu | ||
|
|
||
| You can adjust the time duration by clicking on a x-axis label. |
There was a problem hiding this comment.
Suggested change
| You can adjust the time duration by clicking on a x-axis label. | |
| You can adjust the time duration by clicking on an x-axis label. |
Comment on lines
250
to
251
| The zoom level can be reset through either the data series or chart context menus. | ||
| To access these menus you must either click on a data point or an empty space in the plot, respectively. |
There was a problem hiding this comment.
Suggested change
| The zoom level can be reset through either the data series or chart context menus. | |
| To access these menus you must either click on a data point or an empty space in the plot, respectively. | |
| 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 through either the data series or chart context menus. |
There was a problem hiding this comment.
Suggested change
| You can reset the zoom level of a chart through either the data series or chart context menus. | |
| You can reset the zoom level of a chart by clicking on it and choosing "Reset Zoom." |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add new documentation that describes basic chart features. Includes the new features for Plotly JS and some features that already existed (e.g Metric Explorer axis context menus)