Undocumented scatter plot behavior

One of my blog readers, Henrik Toft, reported an undocumented behavior of the well-known scatter plot function: scatter returns a handle to an hggroup-type object that contains child handles of the data points (patch-type objects). This enables easy manipulation of specific points (for example, changing the color or marker of interesting data points).
The undocumented behavior is that when the scatter plot contains more than 100 points, the returned hggroup object only has a single child – a handle to a unified patch object that contains all the data points. This prevents customization of specific points: color can be customized via the cdata property, but this is not trivial; the marker cannot be customized at all.
Both Henrik and I initially thought this was a simple bug. But when Henrik reported this issue to MathWorks support, he got the response that this is indeed the expected behavior (i.e., not a bug but a feature), which is not documented. MathWorks did not say whether this was because they didn’t think users need more than 100 child handles, or perhaps an issue with memory/performance. Whatever the reason, I feel that this behavior/feature should at least be documented:

>> hggroup = scatter(rand(99,1),rand(99,1));
>> size(get(hggroup,'Children'))
ans =
    99     1
>> hggroup = scatter(rand(100,1),rand(100,1));
>> size(get(hggroup,'Children'))
ans =
   100     1
>> hggroup = scatter(rand(101,1),rand(101,1));
>> size(get(hggroup,'Children'))
ans =
     1     1

Workaround: use the ‘v6’ option. Unfortunately, this option is deprecated and marked as obsolete by Matlab, with the warning that it will be removed in a future Matlab version. I hope this will not be done until a better workaround for the above-reported issue is implemented in the scatter function:

>> hPatches = scatter('v6',rand(101,1),rand(101,1));
Warning: The 'v6' argument to SCATTER is deprecated, and will no longer be supported in a future release.
> In usev6plotapi>warnv6args at 84
  In usev6plotapi at 40
  In scatter at 39
>> size(hPatches)
ans =
   101     1

If you have detected any other undocumented behavior, function or feature in Matlab, please report them in the comments section below, or directly by email to me: altmany at gmail dot com.

18 Responses

Naor October 12, 2009 at 11:59 Reply

Interesting. I use scatter with thousands of points all the time. Perhaps I am misusing it then? I don’t really need the ability to access each data marker but scatter is just an easy function to work with.

Yair Altman October 12, 2009 at 13:01 Reply

Naor – Perhaps I should have been clearer: scatter works correctly even with 101+ data points, as you correctly said. However, the returned value in this case is simply a single patch handle rather than hundreds or thousands of separate data-point handles. If you don’t need to customize specific data points then this issue doesn’t really matter; but if you do need this ability, you need to use the obsolete ‘v6’ option.

Venkat October 12, 2009 at 22:33 Reply

Hi Yair,
In my GUI, I have to add/delete/adjust lot of graphs. In matlab compiler documentation, PLOTTOOLS is stated under List of Unsupported Functions.
Is there any way to get PLOTTOOLS working with the compiled code of standalone EXE?

Yair Altman October 13, 2009 at 01:50 Reply

Venkat – Interesting question. Unfortunately, I do not know if it can be done or how.

Sebastiaan October 13, 2009 at 06:08 Reply
I do not like the method of using deprecated functions – they might just disappear the next release.

I suggest using something like this:
data = rand(227,2); hggroup(1) = scatter(data(1:100,1),data(1:100,2)); hold on hggroup(2) = scatter(data(101:200,1),data(101:200,2)); hggroup(3) = scatter(data(201:227,1),data(201:227,2));
data = rand(227,2); hggroup(1) = scatter(data(1:100,1),data(1:100,2)); hold on hggroup(2) = scatter(data(101:200,1),data(101:200,2)); hggroup(3) = scatter(data(201:227,1),data(201:227,2));
By default, it is plotted in different colours, but that can be easily overcome.

Sebastiaan
Performance: scatter vs. line | Undocumented Matlab October 14, 2009 at 08:01 Reply

[…] Charting Matlab’s unsupported hidden underbelly « Undocumented scatter plot behavior […]
Boyan March 26, 2010 at 09:15 Reply

Hi
This article has been very useful for me! I struggled few hours with this before I found this. Since I need to manipulate the individual points in a specific order it is worth noting that the order in, which the handle is returned with the ‘v6’ option is exactly the opposite of what the ‘Children’ property returns meaning that the first object is on top instead of on the bottom. I hope this helps to others and I have to say it is very disappointing Matlab decided to do this in such manner…

Boyan
jacob January 12, 2012 at 01:53 Reply

Thanks a lot! It took me quite a while to figure out why my functions suddenly stopped working.
Again, thanks! you made my day.
Undocumented scatter plot jitter | Undocumented Matlab June 6, 2012 at 06:05 Reply

[…] You may also be interested in the article I posted a few years ago about another undocumented scatterplot behavior […]

Mohit (6 days 14 hours 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 (8 days 13 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 (14 days 23 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 (30 days 16 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 11 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 12 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 12 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 (35 days 19 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 5 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 (48 days 14 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 6 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 8 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 8 hours ago): Hi Yair, it seems that in Matlab R2019b this method doesn’t work. Have you some solutions? Thanks.
Maurizio (69 days 18 hours ago): Thank you Yair, I’ve supposed it, but I was not sure. Maurizio
Yair Altman (70 days 9 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:

18 Responses

Leave a Reply