Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User documentation for the PlotSelection feature #4146

Merged
merged 5 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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