Skip to content

Commit

Permalink
Print plot command interface instead of maintaining options.
Browse files Browse the repository at this point in the history
  • Loading branch information
@adeas31
adeas31 committed Mar 3, 2016
1 parent 19af68b commit bf13bed
Showing 1 changed file with 9 additions and 44 deletions.
53 changes: 9 additions & 44 deletions UsersGuide/source/plotting.rst
View file
Expand Up @@ -57,47 +57,12 @@ The results are identical, except the detailed plot has a smoother curve.
x
Plotting Commands and their Options
-----------------------------------

All of these commands can have any number of optional arguments to
further customize the the resulting diagram. The available options and
their allowed values are listed below.

+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| **Option** | **Default value** | **Description** |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| fileName | "<default>" | The name of the result-file containing the variables to plot. <default> will read the last simulation result|
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| grid | "detailed" | Sets the grid for the plot i.e simple, detailed, none. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| title | "" | This text will be used as the diagram title. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| logX | false | Determines whether or not the horizontal axis is logarithmically scaled. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| logY | false | Determines whether or not the vertical axis is logarithmically scaled. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| xLabel | "time" | This text will be used as the horizontal label in the diagram. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| yLabel | "" | This text will be used as the vertical label in the diagram. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| xRange | {0, 0} | Determines the horizontal interval that is visible in the diagram. {0, 0} will select a suitable range. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| yRange | {0, 0} | Determines the vertical interval that is visible in the diagram. {0, 0} will select a suitable range. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| curveWidth | 1.0 | Defines the width of the curve. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| curveStyle | 1 | Defines the style of the curve. |
| | | |
| | | SolidLine=1, DashLine=2, DotLine=3, DashDotLine=4, DashDotDotLine=5, Sticks=6, Steps=7. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| legendPosition | "top" | Defines the position of the legend in the diagram. Possible values are left, right, top, bottom and none. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| externalWindow | false | Opens a new OMPlot window if set to true otherwise update the current opened window. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| footer | "" | This text will be used as the diagram footer. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| autoScale | true | Use auto scale while plotting. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
| forceOMPlot | false | If true launches OMPlot and doesn't call callback function even if it is defined. |
+------------------+-------------------------------------+-------------------------------------------------------------------------------------------------------------+
Plot Command Interface
----------------------

Plot command have a number of optional arguments to
further customize the the resulting diagram.

.. omc-mos ::
list(OpenModelica.Scripting.plot,interfaceOnly=true)

0 comments on commit bf13bed

Please sign in to comment.