docs updates

* explain layer cycling for mouseover/markers * link to plugin docs and API docs for exporting table from markers plugin
spacetelescope · Mar 16, 2023 · 1443057 · 1443057
1 parent f9b46cf
commit 1443057
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 0 deletions.
diff --git a/docs/cubeviz/export_data.rst b/docs/cubeviz/export_data.rst
@@ -126,3 +126,10 @@ the ``x`` and ``y`` parameters identify specifically which spaxel fits are to be
 for models applied to every spaxel using the :guilabel:`Apply to Cube` button.
 Leaving ``x`` or ``y`` as ``None`` will mean that the models fit to every spaxel
 across that axis will be returned.
+
+Markers Table
+=============
+
+All mouseover information in the :ref:`markers plugin <markers-plugin>` can be exported to an
+:ref:`astropy table <astropy:astropy-table>`
+by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`).
diff --git a/docs/imviz/displayimages.rst b/docs/imviz/displayimages.rst
@@ -35,6 +35,10 @@ cursor's location in pixel space (X and Y), the RA and Dec at that point, and th
 of the data there. This information is displayed in the top bar of the UI, on the
 middle-right side.
 
+By default, the cursor information will correspond to the top image layer in the viewer.
+To change to a specific data-layer, click the layer-icon in the top bar to cycle between
+"auto", "cursor", or specific data layers.
+
 Notes on GWCS
 -------------
 

diff --git a/docs/imviz/export_data.rst b/docs/imviz/export_data.rst
@@ -111,3 +111,10 @@ The columns are as follow:
 
 Once you have the results in a table, you can further manipulated them as
 documented in :ref:`astropy:astropy-table`.
+
+Markers Table
+=============
+
+All mouseover information in the :ref:`markers plugin <markers-plugin>` can be exported to an
+:ref:`astropy table <astropy:astropy-table>`
+by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`).
diff --git a/docs/specviz/displaying.rst b/docs/specviz/displaying.rst
@@ -51,6 +51,10 @@ cursor position as well as the spectral axis value, pixel, and flux of the close
 to the cursor.
 This information is displayed in the top bar of the UI, on the middle-right side.
 
+By default, the cursor information will correspond to the closest data layer to the cursor.
+To change to a specific data-layer, click the layer-icon in the top bar to cycle between
+"auto", "cursor", or specific data layers.
+
 Home
 ====
 

diff --git a/docs/specviz/export_data.rst b/docs/specviz/export_data.rst
@@ -96,3 +96,10 @@ To extract all of the model parameters:
     myparams
 
 where the ``model_label`` parameter identifies which model should be returned.
+
+Markers Table
+=============
+
+All mouseover information in the :ref:`markers plugin <markers-plugin>` can be exported to an
+:ref:`astropy table <astropy:astropy-table>`
+by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`).
diff --git a/docs/specviz2d/export_data.rst b/docs/specviz2d/export_data.rst
@@ -37,3 +37,11 @@ An instance of Specviz can also be accessed, which exposes some helper methods f
 
     :ref:`Specviz: Export Data <specviz-export-data>`
         Specviz documentation on exporting spectra.
+
+
+Markers Table
+=============
+
+All mouseover information in the :ref:`markers plugin <markers-plugin>` can be exported to an
+:ref:`astropy table <astropy:astropy-table>`
+by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`).