Differences

This shows you the differences between two versions of the page.

Link to this comparison view

reference:ft_plot_box [2018/08/23 14:43] (current)
Line 1: Line 1:
 +=====  FT_PLOT_BOX =====
 +
 +Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help ft_plot_box"​.
 +
 +<​html><​pre>​
 +  <a href=/​reference/​ft_plot_box><​font color=green>​FT_PLOT_BOX</​font></​a>​ plots the outline of a box that is specified by its lower
 +  left and upper right corner
 + 
 +  Use as
 +    ft_plot_box(position,​ ...)
 +  where the position of the box is specified as is [x1, x2, y1, y2].
 + 
 +  Optional arguments should come in key-value pairs and can include
 +    '​facealpha' ​      = transparency value between 0 and 1
 +    '​facecolor' ​      = color specification as [r g b] values or a string, for example '​brain',​ '​cortex',​ '​skin',​ '​red',​ '​r'​
 +    '​edgecolor' ​      = color specification as [r g b] values or a string, for example '​brain',​ '​cortex',​ '​skin',​ '​red',​ '​r'​
 +    '​tag' ​            = string, the name assigned to the object. All tags with the same name can be deleted in a figure, without deleting other parts of the figure.
 + 
 +  It is possible to plot the object in a local pseudo-axis (c.f. subplot), which is specfied as follows
 +    '​hpos' ​           = horizontal position of the center of the local axes
 +    '​vpos' ​           = vertical position of the center of the local axes
 +    '​width' ​          = width of the local axes
 +    '​height' ​         = height of the local axes
 +    '​hlim' ​           = horizontal scaling limits within the local axes
 +    '​vlim' ​           = vertical scaling limits within the local axes
 +    '​parent' ​         = handle which is set as the parent for all plots
 + 
 +  Example
 +    ft_plot_box([-1 1 2 3], '​facecolor',​ '​b'​)
 +    axis([-4 4 -4 4])
 + 
 +  See also <a href=/​reference/​ft_plot_line><​font color=green>​FT_PLOT_LINE</​font></​a>,​ <a href=/​reference/​ft_plot_crosshair><​font color=green>​FT_PLOT_CROSSHAIR</​font></​a>​
 +</​pre></​html>​