doc/salome/gui/GUI/input/plot2d_viewer.doc

   1 /*!
   2
   3 \page plot2d_viewer_page Plot 2D viewer
   4
   5 \n <b>Plot 2d viewer</b> is destined to the representation of  2d
   6 plots and graphs in Post-Pro module.
   7 \n Its viewer toolbar gives you fast access to the following
   8 operations:
   9
  10 \image html image77.gif
  11 <center><b>Dump View</b> - exports an object from the viewer in bmp,
  12 png, jpg or jpeg image format.</center>
  13
  14 \image html image96.gif
  15 <center><b>Fit all</b> - scales the display to show the entire
  16 scene. Use this to resize the scene so that it could fit within the
  17 Viewer boundary.</center>
  18
  19 \image html image97.gif
  20 <center><b>Fit area</b> - resizes the view to place in the visible
  21 area only the contents of a frame drawn with pressed left mouse
  22 button.</center>
  23
  24 \image html image98.gif
  25 <center><b>Zoom</b> - allows to zoom in and out.</center>
  26
  27 \image html image99.gif
  28 <center>\b Panning - if the represented objects are greater that the
  29 visible area and you don't wish to use Fit all functionality, click on
  30 this button and you'll be able to drag the scene to see its remote
  31 parts.</center>
  32
  33 \image html image100.gif
  34 <center><b>Global panning</b> - allows to define the center of the
  35 scene presenting all displayed objects in the visible area.</center>
  36
  37 \image html plot2d_points.gif
  38 <center><b>Draw Points</b> - represents points on the graph.</center>
  39
  40 \image html plot2d_lines.gif
  41 <center><b>Draw Lines</b> - represents lines on the graph.</center>
  42
  43 \image html plot2d_splines.gif
  44 <center><b>Draw Splines</b> - represents splines on the graph.</center>
  45
  46 \image html plot2d_logarithmic_horizontal.gif
  47 <center><b>Horizontal axis logarithmic</b> - changes the scaling on
  48 horizontal axis to logarithmic.</center>
  49
  50 \image html plot2d_logarithmic_vertical.gif
  51 <center><b>Vertical axis logarithmic</b> - changes the scaling on vertical
  52 axis to logarithmic.</center>
  53
  54 \image html plot2d_legend.gif
  55 <center><b>Show Legend</b> - reveals all verbal and numerical
  56 information on the graphs.</center>
  57
  58 \image html plot2d_settings.gif
  59 <center>\b Settings - calls a menu, in which you can specify advanced
  60 settings for your Plot 2d Viewer.</center>
  61
  62 \image html plot2d_clone.gif
  63 <center><b>Clone view</b> - opens a new duplicate scene.</center>
  64
  65 \anchor settings
  66 \n \image html plot2d_view_settings.png
  67
  68 The options are as follows:
  69 <ul>
  70 <li><b>Main title:</b> the title of the XY plot. By default, it will
  71 consist of the names of the tables, on the basis of which the curve
  72 lines have been constructed.</li>
  73 <li><b>Curve type:</b> you can select from \b Points, \b Lines and \b Spline.</li>
  74 <li><b>Show legend:</b> here you can define the position of the
  75 description table on the XY plot (to the \b Left, to the \b Right, on
  76 \b Top or on \b Bottom).</li>
  77 <li><b>Marker size</b> - size of the points (markers) forming curve lines.</li>
  78 <li><b>Background color</b> of the XY plot.</li>
  79 <li><b>Scale mode:</b> here you can select the type of scaling (\b
  80 Linear or \b Logarithmic) along <b>X (Horizontal)</b> or <b>Y (Vertical)</b> axes.</li>
  81 </ul>
  82
  83 You can define settings for each axis separately:
  84 <ul>
  85 <li>\b Horizontal or \b Vertical axis title.</li>
  86 <li><b>Grid/Axes marks:</b>  here you can define the maximum number of major
  87 and minor scale divisions for a specified axis. The real number of
  88 intervals fits to {1,2,5}*10^N, where N is a natural number, and
  89 doesn't exceed the maximum.</li>
  90 <li><b>Save settings as default:</b> If this check box is marked, all
  91 XY plots will be displayed with these defined properties.</li>
  92 </ul>
  93
  94 */