functionplot
Displays a plot with selected variables using OMPlot.
Information
Returns true on success.
Example command sequences:
simulate(A); plot({x,y,z});simulate(A); plot(x, externalWindow=true);simulate(A,fileNamePrefix="B"); simulate(C); plot(z,fileName="B.mat",legendPosition=none);
Inputs
| Type | Name | Default | Description |
|---|---|---|---|
| VariableNames | vars | The variables you want to plot | |
| Boolean | externalWindow | false | Opens the plot in a new plot window |
| String | fileName | "<default>" | The filename containing the variables. <default> will read the last simulation result |
| String | title | "" | This text will be used as the diagram title. |
| String | grid | "simple" | Sets the grid for the plot i.e simple, detailed, none. |
| Boolean | logX | false | Determines whether or not the horizontal axis is logarithmically scaled. |
| Boolean | logY | false | Determines whether or not the vertical axis is logarithmically scaled. |
| String | xLabel | "time" | This text will be used as the horizontal label in the diagram. |
| String | yLabel | "" | This text will be used as the left vertical label in the diagram. |
| Real[2] | xRange | {0.0, 0.0} | Determines the horizontal interval that is visible in the diagram. {0,0} will select a suitable range. |
| Real[2] | yRange | {0.0, 0.0} | Determines the left vertical interval that is visible in the diagram. {0,0} will select a suitable range. |
| Real | curveWidth | 1.0 | Sets the width of the curve. |
| Integer | curveStyle | 1 | Sets the style of the curve. SolidLine=1, DashLine=2, DotLine=3, DashDotLine=4, DashDotDotLine=5, Sticks=6, Steps=7. |
| String | legendPosition | "top" | Sets the POSITION of the legend i.e left, right, top, bottom, none. |
| String | footer | "" | This text will be used as the diagram footer. |
| Boolean | autoScale | true | Use auto scale while plotting. |
| Boolean | forceOMPlot | false | if true launches OMPlot and doesn't call callback function even if it is defined. |
| String | yAxis | "L" | Sets the variable to be plotted on the left (L) or right (R) y-axis. |
| String | yLabelRight | "" | This text will be used as the right vertical label in the diagram. |
| Real[2] | yRangeRight | {0.0, 0.0} | Determines the right vertical interval that is visible in the diagram. {0,0} will select a suitable range. |
Outputs
| Type | Name | Default | Description |
|---|---|---|---|
| Boolean | success | Returns true on success |