doc/salome/gui/input/plot2d_viewer.rst

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