Changeset 35f4d43 in sasview for src/sas

Timestamp:

Sep 15, 2016 8:33:57 AM (8 years ago)

Author:

Piotr Rozyczko <rozyczko@…>

Branches:

ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc

Children:

6027eb3

Parents:

752f12d

git-author:

paul butler <butlerpd@…> (09/06/16 01:57:55)

git-committer:

Piotr Rozyczko <rozyczko@…> (09/15/16 08:33:57)

Message:

update the graph/plotting documentation with new set axis range option,
fixed information on modifying plots and added new image for linearized
fits that includes new look. Fixes #621

Location:

src/sas/sasgui/guiframe/media

Files:

• graph_help.rst (modified) (7 diffs)
• guinier_fit.png (modified) (previous)

src/sas/sasgui/guiframe/media/graph_help.rst

@@ -42 +42 @@
 plot window.
 
-*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up
-after computation.*
+.. note:: 
+    *If a residuals graph (when fitting data) is hidden, it will not show up
+    after computation.*
 
 Dragging a plot
@@ -67 +68 @@
 After zooming in on a a region, the *left arrow* or *right arrow* buttons on
 the toolbar will switch between recent views.
+
+The axis range can also be specified manually.  To do so go to the *Graph Menu*
+(see Invoking_the_graph_menu_ for further details), choose the *Set Graph Range*
+option and enter the limits in the pop box.
 
 *NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out
@@ -116 +121 @@
 ^^^^^^^^^^^^^^^^^^^
 
-From the *Graph Menu* (see Invoking_the_graph_menu_) it is also possible to
-make some custom modifications to plots, including:
+It is possible to make custom modifications to plots including:
 
 *  changing the plot window title
-*  changing the axis legend locations
-*  changing the axis legend label text
-*  changing the axis legend label units
-*  changing the axis legend label font & font colour
+*  changing the default legend location and toggling it on/off
+*  changing the axis label text
+*  changing the axis label units
+*  changing the axis label font & font colour
 *  adding/removing a text string
 *  adding a grid overlay
+
+The legend and text strings can be drag and dropped around the plot
+
+These options are accessed through the *Graph Menu* (see Invoking_the_graph_menu_)
+and selecting *Modify Graph Appearance* (for axis labels, grid overlay and
+legend position) or *Add Text* to add textual annotations, selecting font, color,
+style and size. *Remove Text* will remove the last annotation added. To change
+the legend. *Window Title* allows a custom title to be entered instead of Graph
+x. 
 
 Changing scales
@@ -234 +247 @@
 selected data will be removed from the plot.
 
-*NOTE! This action cannot be undone.*
+.. note::
+    The Remove data set action cannot be undone.
 
 Show-Hide error bars
@@ -248 +262 @@
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Modify Plot
 Property* to change the size, color, or shape of the displayed marker for the
-chosen dataset, or to change the dataset label that appears on the plot.
+chosen dataset, or to change the dataset label that appears in the plot legend
+box.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -292 +307 @@
 average.
 
-*NOTE! The displayed average only updates when input focus is moved back to
-that window; ie, when the mouse pointer is moved onto that plot.*
+.. note::
+    The displayed average only updates when input focus is moved back to
+    that window; ie, when the mouse pointer is moved onto that plot.
 
 Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in
@@ -359 +375 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 01May2015
+.. note::  This help document was last modified by Paul Butler, 05 September, 2016