Skip to content

Commit

Permalink
Merge pull request #4146 from RebeloAlexis/doc
Browse files Browse the repository at this point in the history
User documentation for the PlotSelection feature
  • Loading branch information
t20100 authored Jul 5, 2024
2 parents 29faee7 + b45bfac commit 6062adf
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 4 deletions.
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.
40 changes: 36 additions & 4 deletions doc/source/applications/view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,41 @@ and to view this data in plot widgets or in simple table views.
* - |imgViewHdf5|
- Viewing metadata and HDF5 attributes

Custom plot selection
---------------------

Usage
-----
.. grid :: 1 2 2 2
.. grid-item-card::
:columns: 12
:text-align: center
.. figure:: img/silx-view-plotSelection.png
:align: center
Plot custom curves from selected 1D datasets.
How to access :
............

.. grid :: 1 2 2 2
.. grid-item-card::
:columns: 12
:text-align: center
.. figure:: img/silx-view-plotMenu.png
:align: center
Open the 'Plot selection' window (View menu -> Plot selection)
.. figure:: img/silx-view-dropPlot.png
:align: center
The "Plot selection" window opens: You can plot custom curves by dragging and dropping 1D datasets from "silx view" to "Plot selection" window's "X" and "Y" fields.
Command line
------------

.. code-block:: none
Expand All @@ -60,8 +92,8 @@ Options
--hdf5-file-locking Start the application with HDF5 file locking enabled (it is disabled by
default)
Examples of usage
-----------------
Examples
--------

Open file(s)
............
Expand Down

0 comments on commit 6062adf

Please sign in to comment.