HG's undocumented parameters interface

March 14, 2013 6 Comments

Continuing last week’s article on Matlab Handle Graphics’ (HG) undocumented Behavior functionality, today I describe another undocumented aspect of HG. Some of the low-level HG functions, such as line and patch receive their input parameters in one of two formats:

HG line created using either of the input formats

The regular fully-documented P-V pairs format:
line('Marker','*', 'MarkerSize',8, 'MarkerEdgeColor','b', ... 'Color','r', 'XData',1:5, 'YData',3:7)
line('Marker','*', 'MarkerSize',8, 'MarkerEdgeColor','b', ... 'Color','r', 'XData',1:5, 'YData',3:7)
An undocumented struct-fields format:
lineprops.Marker = '*'; lineprops.MarkerSize = 15; lineprops.MarkerEdgeColor = 'b'; lineprops.color = 'r'; lineprops.xdata = 1:5; lineprops.ydata = 3:7; line(lineprops)
lineprops.Marker = '*'; lineprops.MarkerSize = 15; lineprops.MarkerEdgeColor = 'b'; lineprops.color = 'r'; lineprops.xdata = 1:5; lineprops.ydata = 3:7; line(lineprops)

A sample usage of using the input struct technique can be seen (for example) in %matlabroot%/toolbox/matlab/graphics/@graphics/@datatip/datatip.m. I have also used it in my IB-Marlab application, which connects Matlab to Interactive Brokers. The idea is to make it easy for users to use whichever input format they feel more comfortable with: both P-V pairs or struct fields are supported.
Both input formats can be interchanged and mixed. We should just note that the latest (right-most) property is updated last and overrides any previous value of the same property. Here are some examples — can you guess the results of each of them?

line(lineprops, 'MarkerEdgeColor','g', 'MarkerSize',7)
line('MarkerEdgeColor','g', lineprops, 'MarkerSize',7)
line('MarkerEdgeColor','g', 'MarkerSize',7, lineprops)
line(1:4, 2:5, 'MarkerEdgeColor','g', 'MarkerSize',7, lineprops)
line(1:4, 2:5, 'MarkerEdgeColor','g', lineprops, 'MarkerSize',7)
line(1:4, 2:5, lineprops, 'MarkerEdgeColor','g', 'MarkerSize',7)

While the struct format is documented (although not widely-used) in the set function, it is not documented for line, patch and other functions. Nor is it documented that we can mix the struct format with the P-V pairs format.
Note that not all HG functions support the struct input format. For example, line does, but plot does not. I do not understand the reason for this. It would seem reasonable for MathWorks to include this useful struct format for all their HG functions, and since set already supports it the extra effort would have been trivial. Maybe this will still happen in some future Matlab release…

6 Responses

Eric March 14, 2013 at 08:13 Reply

Is this behavior because the functions use INPUTPARSER? If so, perhaps it is true for any function that uses inputparser – I haven’t tested it out to see…

Yair Altman March 14, 2013 at 08:17 Reply

@Eric – both line, patch and inputparser are internal functions whose contents are not accessible for us to check.

ishghandle’s undocumented input parameter | Undocumented Matlab March 27, 2013 at 14:09 Reply

[…] Two weeks ago I wrote about Matlab Handle Graphics (HG) undocumented acceptance of structs as input parameter to some plotting functions. Continuing in a related matter, today I expose an undocumented input parameter for HG’s ishghandle function […]
Miguel Gaspar April 4, 2013 at 12:25 Reply
I had also noticed this sometime ago. It would seem very useful to use with:
hprops=get(h); hprops.some_property=... set(h,hprops)
hprops=get(h); hprops.some_property=... set(h,hprops)
but unfortunately get(h) returns read-only properties, which result in an error when used with set():
```
>> set(hl,linep)
??? Error using ==> set
Attempt to modify a property that is read-only.
Object Name :  line
Property Name :  'Annotation'.
```
Do you know how to overcome this?

Yair Altman April 4, 2013 at 14:30 Reply
@Miguel – why not simply pass to set only the changed properties, that you can be certain are settable? For example:
hprops = []; hprops.some_property1 = ... hprops.some_property2 = ... set(h,hprops)
hprops = []; hprops.some_property1 = ... hprops.some_property2 = ... set(h,hprops)

Miguel Gaspar April 4, 2013 at 15:38

Hi, Yair,

Thanks for your reply, and above all, thanks for the continuous stream of pearls you provide…

I would like to use the get() method for two reasons:
– symmetry: it has some aesthetic appeal, feels natural to me;
– laziness: it would allow the use of auto-complete…

not very strong reasons, specially since recent versions of Matlab provide auto-complete of property names in set/get, but still prompted me to write this function:

function hprops=getset(h)
% Returns only the settable properties for the handle graphics object h, so
% that it can be used directly in the form:
% set(h,hprops)
 
fn=fieldnames(set(h(1)));
fv=get(h,fn);
hprops=cell2struct(fv',fn,1);

Unfortunately, although this works for a vector of handles, of same type, returning a vector struct, this can’t be used in set(...):

hlines=findobj(gca,'Type','line');
lineprops=getset(hlines);
lineprops(1).LineStyle=':';
lineprops(2).LineStyle='-';
set(hlines,lineprops)

since only the last value specified for each property is used, and applied to all handle graphics objects…

A syntax for assigning different values to properties of multiple objects is available for the plot(...) function, which accepts the following:

plot(1:4, [2,4,5,8], 'r',...
     1:4, [3 2 1 4], 'g')

My preferred way of working with handle graphics is to use hg objects instead of handles, although in some cases it requires some additional steps:

hline=hg.line('XData',1:4,'YData',[2,4,5,8]);
hline.Visible=false;
hline.XData=[hline.XData,5];
hline.YData=[hline.YData,3];
hline.Visible=true;
% or:
[hline.XData,hline.YData]=deal([hline.XData,5],[hline.YData,3]);

Which method (set(…) with PV pairs, set(…) with struct, or hg objects) do you prefer?

HTML tags such as <b> or <i> are accepted.
Wrap code fragments inside <pre lang="matlab"> tags, like this:

<pre lang="matlab">
a = magic(3);
disp(sum(a))
</pre>

I reserve the right to edit/delete comments (read the site policies).
Not all comments will be answered. You can always email me (altmany at gmail) for private consulting.

Click here to cancel reply.

SKM (21 days 16 hours ago): It is 10 years since the original article, but I would like to bring to attention that such issues have not yet been resolved. For example, programmatically opening and closing files in...
Yair Altman (52 days 2 hours ago): @Ken – I cannot reproduce your report, it works as expected for me even on R2022b
Yair Altman (52 days 5 hours ago): try to use the waitfor function
Danila Berezin (56 days 16 hours ago): Hi I have a similar issue. Did you find a workaround for this?
Ken Johnson (65 days 5 hours ago): Why does the second catch block in this code example not work? (It works if you restart MATLAB and then omit the first try-catch block.) try a = [0,0;0,0]\[1;1]; catch...
Santiago (69 days 20 hours ago): It works perfectly. Thanks so much.
Yair Altman (70 days 1 hour ago): Santiago – you can get the mouse X,Y positions from the Java eventData object (getX(), getY()), convert this into a point (p=java.awt.Point(x,y)), then use the JTable...
Santiago (70 days 17 hours ago): Hi Yair. I’m using the MouseReleasedCallback but I need to get the indices of the selected cell. I can get them without problems with left clicks but, if I try to do it with...
Yair Altman (88 days 21 hours ago): Adam – perhaps there is a builtin syntax-pane control for uifigures, but I am not aware of one. Perhaps you can try to implement a uihtml panel with a GeSHi...
Yair Altman (88 days 21 hours ago): Marcel – 12 years and ~25 releases since I wrote this article, it is no surprise at all that some things no longer work the same way. In fact, the surprising thing is that...
Yair Altman (88 days 21 hours ago): See the documentation of the uitree function. The text in my article refers to the legacy (Java-based) uitree version, which is not documented, whereas it is documented and...
SOULEYMANE Zakaria (94 days 3 hours ago): Hello. Thank you for sharing. I would like to know if someone could help me with the syntax it takes to use uitree on “Appdesigner”. When I use the syntax you...
Nicholas (94 days 15 hours ago): Hello Yair, Have you, or anyone else, had an opportunity to try this demo in R2022a/b? I cannot get the HTMLBrowserPanel object to update with html text (nor with an html file, if...
Marcel (107 days 3 hours ago): Hi, I am trying to set the legend to Static, but this command seems not to work in R2022a anymore: set(gca,’LegendColorbarL isteners’,[]); Any ideas? THANKS / marcel
Gres (107 days 7 hours ago): In 2018b, you can get the icons by calling [hh,icons,plots,txt] = legend({‘Line 1’});

Related posts:

6 Responses

Leave a Reply