doc/salome/gui/input/plot2d_viewer.doc

   1 /*!
   2
   3 \page plot2d_viewer_page Plot 2D viewer
   4
   5 The functionalities of Plot2d viewer are available via its Viewer
   6 Toolbar. Buttons marked with small downward triangles have extended
   7 functionality which can be accessed by locking on them with left mouse
   8 button.
   9
  10 \image html plot2dviewer_toolbar.png
  11 <hr>
  12
  13 \image html plot2d_camera_dump.png
  14
  15 <b>Dump View</b> - exports an object from the viewer in
  16 bmp, png or jpeg image format.
  17 <hr>
  18
  19 \image html plot2d_fitall.png
  20 <b>Fit all</b> - scales the display to show the entire scene. Use this
  21 to resize the scene so that it could fit within the Viewer boundary.
  22 <hr>
  23
  24 \image html plot2d_fitarea.png
  25
  26 <b>Fit area</b> - resizes the view to place in the visible area only
  27 the contents of a frame drawn with pressed left mouse button.
  28 <hr>
  29
  30 \image html plot2d_zoom.png
  31
  32 <b>Zoom</b> - allows to zoom in and out.
  33 <hr>
  34
  35 \image html plot2d_pan.png
  36
  37 \b Panning - if the represented objects are greater that the visible
  38 area and you don't wish to use Fit all functionality, click on this
  39 button and you'll be able to drag the scene to see its remote parts.
  40 <hr>
  41
  42 \image html plot2d_glpan.png
  43
  44 <b>Global panning</b> - allows to define the center of the scene
  45 presenting all displayed objects in the visible area.
  46 <hr>
  47
  48 \image html plot2d_points.png
  49
  50 <b>Draw Points</b> - switches display mode to \em Points. In
  51 this mode, each curve is displayed as a set of points.
  52 <hr>
  53
  54 \image html plot2d_lines.png
  55
  56 <b>Draw Lines</b> - switches display mode to \em Lines. In this
  57 mode, each curve is represented as a set of plain line segments.
  58 <hr>
  59
  60 \image html plot2d_splines.png
  61
  62 <b>Draw Splines</b> - switches display mode to \em Splines. In
  63 this mode, each curve is represented as a spline.
  64 <hr>
  65
  66 \image html plot2d_lmin_normalization.png
  67
  68 <b>Normalization to global minimum by left Y axis</b> - switches
  69 normalization mode to <b>Left Y Axis: Minimum normalization</b>.
  70 In this mode, all curves are normalized to the global minimum by the left Y axis.
  71
  72 \image html plot2d_lmax_normalization.png
  73
  74 <b>Normalization to global maximum by left Y axis</b> - switches
  75 normalization mode to <b>Left Y Axis: Maximum normalization</b>.
  76 In this mode, all curves are normalized to the global maximum by the left Y axis.
  77 <hr>
  78
  79 \image html plot2d_rmin_normalization.png
  80
  81 <b>Normalization to global minimum by right Y axis</b> - switches
  82 normalization mode to <b>Right Y Axis: Minimum normalization</b>.
  83 In this mode, all curves are normalized to the global minimum by
  84 the right Y axis.
  85
  86 \image html plot2d_rmax_normalization.png
  87
  88 <b>Normalization to global maximum by right Y axis</b> - switch
  89 normalization mode to <b>Right Y Axis: Maximum normalization</b>.
  90 In this mode, all curves are normalized to the global maximum by
  91 the right Y axis.
  92 <hr>
  93
  94 \image html plot2d_linear.png
  95 \image html plot2d_log.png
  96
  97 These buttons allow to switch horizontal axis scale to the linear or
  98 logarithmic mode.
  99
 100 \note The logarithmic mode of the horizontal
 101 axis scale is allowed only if the minimum value of abscissa component
 102 of displayed points is greater than zero.
 103
 104 <hr>
 105
 106 \image html plot2d_linear_y.png
 107 \image html plot2d_log_y.png
 108
 109 These buttons allow to switch vertical axis scale to the linear or
 110 logarithmic mode.
 111
 112 \note The logarithmic mode of the vertical
 113 axis scale is allowed only if the minimum value of ordinate component
 114 of displayed points is greater than zero.
 115
 116 <hr>
 117
 118 \image html plot2d_legend.png
 119
 120 <b>Show Legend</b> - Shows / hides information about the displayed
 121 objects in a legend.
 122 <hr>
 123
 124 \image html plot2d_settings.png
 125
 126 \b Settings - provides an access to the settings dialog box, that
 127 allows to specify advanced parameters for the Plot 2d Viewer.
 128
 129 \anchor settings
 130 \image html plot2d_view_settings.png
 131
 132 The following options are available:
 133
 134 - <b>Main title</b> is the XY plot title. By default, it contains the names of tables, from which the curve
 135   lines are constructed.
 136
 137 - <b>Curve type</b> allows selecting from \em Points, \em Lines or  \em Spline.
 138
 139 - <b>Marker size</b> - size of the points (markers) forming curve lines.
 140
 141 - <b>Background color</b> of the XY plot.
 142
 143 - <b>Selection color</b> - defines the color of selected object in the viewer.
 144
 145 - <b>Legend</b> specifies the legend properties.
 146
 147   - <b>Show legend</b> - specifies if the legend is shown by default.
 148
 149   - <b>Legend Position</b> allows positioning the
 150   description table on XY plot (to the \em Left, to the \em Right,
 151   on \em Top or on \em Bottom).
 152
 153   - <b>Symbol type</b> allows positioning the legend item symbol: "Marker on line" or "Marker above line".
 154
 155   - <b>Legend font</b> allows setting font variant, size and style for legend items.
 156
 157   - <b>Legend font color</b> allows selecting the font color for legend items.
 158
 159   - <b>Highlighted legend font color</b> allows selecting font color for selected legend items.
 160
 161 - <b>Deviation marker</b> specifies the properties of the marker, which is used for drawing deviations data.
 162
 163   - <b>Line width</b> line width of the marker.
 164
 165   - <b>Tick size</b> size of the upper and lower horizontal lines of the marker.
 166
 167   - <b>Color</b> color of the marker.
 168
 169 - <b>Normalization</b> allows selecting the type of
 170   normalization (\em minimum or/and \em maximum) for the displayed
 171   presentations of 2d curves in the view.
 172
 173 - <b>Scale mode</b> allows selecting the type of scaling (\em Linear
 174   or \em Logarithmic) for <b>X (Horizontal)</b> or <b>Y (Vertical)</b>
 175   axes separately. Note that the \em Logarithmic scale can be used
 176   only if the minimum value of corresponding component (abscissa or
 177   ordinate) of all points displayed in the viewer is greater than
 178   zero.
 179
 180 - <b>Axis ...</b> options group allows specifying additional settings
 181   for each axis separately:
 182
 183   - <b>Axis title</b> - an axis title.
 184
 185   - <b>Grid / Axes marks</b> allows defining the maximum number
 186     of major and minor scale divisions for a given axis. The real
 187     number of intervals fits to {1,2,5}*10^N, where N is a natural
 188     number, and does not exceed the maximum.
 189
 190 - <b>Save settings as default</b> If this check box is marked, all XY
 191   plots will be displayed with these defined properties.
 192
 193 <hr>
 194
 195 \anchor analytical_curve
 196 \image html plot2d_analytical_curve.png
 197
 198 <b>Analytical curves</b> - provides an access to the analytical curves
 199 dialog box that allows to add, remove and modify analytical curves
 200 for the Plot 2d Viewer.
 201
 202 \image html analytical_curves_dlg.png
 203
 204 The options are as follows:
 205
 206 - Curve parameters:
 207
 208   - <b>y(x)=</b> allows specifying a python expression, which is used to
 209     calculate the coordinates of the curve points, where <b>x</b>
 210     corresponds to the horizontal range, shown in plot 2D viewer.
 211
 212   - <b>Nb. itervals</b> allows specifying the number of the curve points.
 213
 214 - Curve properties:
 215
 216   - <b>Auto assign</b> if checked, the properties
 217     (<em>Line type</em>, <em>Line width</em>, <em>Marker type</em> and
 218     <em>Color</em>) are assigned to curves automatically. To define
 219     the curve properties manually, uncheck this control.
 220
 221   - <b>Line type</b> allows to choose curve line type from \em None,
 222     \em Solid, \em Dash, \em Dot, <em>Dash - Dot</em> and
 223     <em>Dash - Dot - Dot</em>.
 224
 225   - <b>Line width</b> allows to specify line width of the curve.
 226
 227   - <b>Marker type</b> allows to choose curve marker type from
 228     \em Circle, \em Rectangle, \em Diamond, <em>Rightward Triangle</em>,
 229     <em>Leftward Triangle</em>, <em>Downward Triangle</em>,
 230     <em>Upward Triangle</em>, \em Cross and <em>Diagonal Cross</em>).
 231
 232   - <b>Color</b> allows specifying the curve color.
 233
 234 <hr>
 235
 236 \image html plot2d_clone.png
 237
 238 <b>Clone view</b> - opens a new duplicate scene.
 239 <hr>
 240
 241 \image html plot2d_print.png
 242
 243 <b>Print view</b> - prints the current view scene.
 244
 245 */