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 […]

Yair Altman (48 minutes 42 seconds ago): Starting in R2022b the legacy @ syntax has changed from a warning to an error. Classes that use the legacy syntax generate a run-time error and no longer run.
Jeremiah Sullivan (1 hour 51 minutes ago): For what its worth, I am still getting that same “undocumented syntax” warning in 2022a. I really hope they don’t create another breaking change…
SKM (21 days 19 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 5 hours ago): @Ken – I cannot reproduce your report, it works as expected for me even on R2022b
Yair Altman (52 days 8 hours ago): try to use the waitfor function
Danila Berezin (56 days 20 hours ago): Hi I have a similar issue. Did you find a workaround for this?
Ken Johnson (65 days 9 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 23 hours ago): It works perfectly. Thanks so much.
Yair Altman (70 days 5 hours 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 21 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 (89 days 1 hour 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 (89 days 1 hour 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 (89 days 1 hour 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 6 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 18 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...

Related posts:

18 Responses

Leave a Reply