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.

Mohit (7 days 1 hour ago): Hi Yair, I am trying to change keybindings to certain keys for many systems is there any way that we can change these settings. i can change in window dialogue like...
Jan Kappen (9 days 0 hours ago): @Eric, I’m just curious, is the new chart container class (https://de.mathworks.com/help /matlab/ref/matlab.graphics.ch artcontainer.chartcontainer-cl ass.html) the...
Sam (15 days 10 hours ago): Doesn’t work for me! I am using Matlab 2018a, no different at all, even the exe file size is the same.
Joonas T. Holmi (31 days 2 hours ago): Very good comment Yair! I posted the above function too hastily… I will have to apologize for claiming above that it allows updating MATLAB’s jar files without...
Yair Altman (32 days 22 hours ago): @Claudio – I don’t know exactly what you did in your code, the following works perfectly fine for me on R2020a: jComponent = com.jidesoft.combobox.DateComb oBox;...
Yair Altman (34 days 22 hours ago): Thanks for sharing Joonas – this seems useful indeed. Users who will use your script are probably savvy Java programmers, who don’t need a reminder of the dangers in...
Joonas T. Holmi (34 days 22 hours ago): Yair and others, I found yet another way to add files to Java’s class path. See the function java_class_path_add_before_sta tic(file) below. Benefit of this new method...
Joonas T. Holmi (36 days 6 hours ago): Krishnan, It is ‘java.lang.System.getPro perty‘ and ‘java.lang.System.setPro perty‘. I read that JVM uses ‘java.class.path’ content only...
claudio (43 days 16 hours ago): Hi Yair i’m trying to set default string in DateComboBox to display before selecting date from date panel jElement.getEditor.getEditorCo mponent.setText('Set default date')...
Loren Shure (49 days 0 hours ago): Hi Yair- Very nice example showing people how to delve in – plus a nice heads up for us to always go back and look at our shipping code. Probably feval was the only option...
Michelle Hirsch (51 days 17 hours ago): Thanks Yair, as always, for the thoughtful post. I’ve forwarded it to the folks from both the Statistics team and the Performance team for their input. Happy Pesach!
Maurizio (66 days 19 hours ago): Hi Yair, how can I define a callback for a cell/row/column selection? In createTable you can define a data changed callback, but if you simply select a cell, how can you define a...
Donato (68 days 19 hours ago): Hi Yair, it seems that in Matlab R2019b this method doesn’t work. Have you some solutions? Thanks.
Maurizio (70 days 5 hours ago): Thank you Yair, I’ve supposed it, but I was not sure. Maurizio
Yair Altman (70 days 19 hours ago): headers is a simple cell array of strings (column header names). I thought that was pretty obvious from the context… Additional types of uitable customizations are...

Related posts:

6 Responses

Leave a Reply