Options







addTag

plt(...,'addTag',{'tag1' @action1 'tag2' @action2 ... });

Adds one or more tags to the bottom of the menu box. 'tag1' can be any string that you want to add to the menubox and @action1 can be any function name that will be executed when this new tag is clicked. If you need to include parameters to the function you can replace @action1 with something like {@action1 arg1 arg2 arg3}. If you want to define the function as a string you could replace @action1 with something like 'disp("The tag1 tag has been clicked");'.

The default color for the new tags is yellow so that it will stand out from the usual menu box tags, but you can change the color of the tag if you like by appending the color to the name of the tag deliminated by two vertical bar characters. For example if you want to make the first tag blend in by using the [.7 .8 .95] default color of the usual menu box tags and make the second tag red you would use:

plt(...,'addTag',{'tag1||.7 .8 .95' @action1 'tag2||0 0 1' @action2 ... });

or equivalently you could use the one of the alternate plt color specifiers as in:

plt(...,'addTag',{'tag1||708095' @action1 'tag2||1' @action2 ... });

The programs demo\vbar.m, math\gpsLog.m, and sig\winplt.m all serve as examples of using the addTag parameter.

HelpFile

plt(...,'HelpFile','filename'); Specifies the left click action of the menu box Help tag:

If the filename is specified with complete path information the helpfile will be read from the specified location. If no path information is included, plt looks for this file on the Matlab path (except for compiled applications in which case plt looks for the file in the same folder that contains the executable). The file extension must be included in the filename string since the extension determines which application is used to open the help file. (If you don't include an extension plt will assume that it is an executable command, and plt will simply call that executable when you click on the Help tag.) The extension may be .html, .pdf, or .chm, or any file type that your operating system knows how to open. (Usually, chm files are only supported on PC systems.) Assuming the help file is found, it will be opened when you left-click on the help tag. Also if the file specified is a chm file, then it also may be followed by a topic specifier which causes the chm file to open pointed at the chosen topic. (The demo programs plt5.m, editz.m, winplt.m and julia.m demonstrate the use of the HelpFile parameter to open a chm file at a specified topic.)

If the HelpFile parameter is not included, left-clicking on the help tag will open the default plt help file (plt.chm on Windows systems and the file plt.htm otherwise). If both plt.chm and plt.htm are not found, then one of the files xxx.chm, xxx.htm, or xxx.pdf will be opened where "xxx" is the current figure name. If none of those files are found, a warning message will appear indicating that no help files were found.

HelpFileR

plt(...,'HelpFileR','filename'); Specifies the right click action of the menu box Help tag:

The rules for finding the help file are the same as described above for the HelpFile parameter. Assuming the help file is found, it will be opened when you right-click on the help tag. If this parameter is not included, right-clicking on the help tag will toggle the helptext if it was defined using the plt 'HelpText' argument. If the 'HelpText' argument was not supplied in the plt argument list, then right-clicking on the help tag will open the default plt help file. Often the help tag left click will be used for help on the plt plotting package and the right click will be used for help on the currently running program. Or the roles of left and right clicks may be reversed. The demo program demo\plt50.m gives an example of using the HelpFileR option.

Options

plt(...,'Options',s);

s is a string specifying one or more options. The options allowed are:

'Ticks' Use tick marks (i.e. no grid lines)
'Menu' Enable the figure menu bar
'xView' Enable the xView slider
'Slider' Enable the x-axis control slider
'Xlog' use logarithmic scaling on the x axis
'Ylog' use logarithmic scaling on the y axis
'multiCur' Enables the multiCursor. The Y cursor edit box only displays the value of the currently selected trace, but with the multiCursor enabled, the values of all the traces are shown at the current cursor index. This mode can also be turned on or off by the user after the plot has been created. See the "multiCursor" heading in the Cursoring section
'tidcuR' The multiCursor option described in the line above is the clearest way to show the values of all the traces at the current cursor index ... however, it does add a lot of clutter in the plot region. An alternate method of displaying all these cursor values without cluttering up the plot region is to use the TraceID box to display these values. The 'tidcuR' option enables this alternative. If you find 'tidcuR' cryptic you could use 'trace id cursoR' or 'multicursoR' or simply 'R' or any other string containing the capital letter R. The fseries.m application (in the sig folder) demonstrates the use of the 'tidcuR' option. By default, these multicursor values are displayed using 6 digits (with the '%6v' conversion format). If you wanted to change this to 5 digits, you could add the command: setappdata(gca,'tidcuR',5) or you could specify a conversion string such as: setappdata(gca,'tidcuR','%07.4f'). (The example program pub2.m demonstrates the use of this application data value for controlling the tid cursor formatting.)
'Nocursor' Tells plt to hide all cursor objects. They may be re-enabled with the command: cur(0,'visON');
'noButton' Tells plt to hide the cursor button group (4 buttons). They may be re-enabled with the commands: a = cur(0,'obj'); set(a(7:10),'vis','on');
'Hidden' Tells plt to exit with the plot figure as usual, but leave the figure window hidden.
'Linesmoothing' Tells plt to use Matlab's line smoothing algorithm (anti-aliasing) for all traces. The line smoothing property may also be controlled from the cursor button group which is described in the Cursoring section. Be aware that line smoothing probably will not work on versions of Matlab older than about 2008. Also the line smoothing property is ignored in version Matlab R2014b or later because lines are always smoothed (at least with relatively recent graphics hardware).
'Ignorecfile' If you have defined your own color scheme using a color file, this option allows you to revert to the default plt color scheme without deleting the color file used for your other applications.
'-Help'
'+Help'
removes/adds the Help tag from the menu box
'-Xlog'
'+Xlog'
removes/adds the LinX/LogX tag from the menu box
'-Ylog'
'+Ylog'
removes/adds the LinY/LogY tag from the menu box
'-Grid'
'+Grid'
removes/adds the Grid tag from the menu box
'-Data'
'+Data'
removes/adds the Data tag from the menu box
'-Mark
'+Mark'
removes/adds the Mark tag from the menu box
'-Zout
'+Zout'
removes/adds the Zout tag from the menu box
'-Rotate'
'+Rotate'
removes/adds the XYrotate (XY↔) tag from the menu box
'-All'
'+All'
removes /adds all menu box items

These options strings are case sensitive and in fact only the capital letters are significant. You can add whatever lowercase letters, spaces, and other delimiters that you want to make the string more readable. For example, suppose you wanted the display to initialize with the menu bar and multiCursor enabled and the grid lines off. Any of these commands would achieve that goal:
   plt(...,'Options','Menu','Options','multiCur, Ticks');
   plt(...,'Options','Menu multiCursor Ticks');
   plt(...,'Options','MCT');
   plt(...,'Options','M,C,T');

In addition to those options, suppose you wanted to remove the "Grid" tag from the menuBox. Then we would use something like one of the following:
   plt(...,'Options','Menu Cur Tick -Grid');
   plt(...,'Options','MCT-G');

You can also use a plus sign on the menu box tags if you would rather specify which tags to include instead of which tags to remove. For example, both of the following commands would remove all the menu box items except for the x and y axis lin/log controls:
   plt(...,'Options','-H-G-D-M-Z-R');
   plt(...,'Options','+X+Y');
If you remove all menu box items (i.e. 'Options','-A'), the box outline is not displayed as well.