Undocumented HG2 graphics events

May 27, 2015 18 Comments

R2014b brought a refreshing new graphics engine and appearance, internally called HG2 (the official marketing name is long and impossible to remember, and certainly not as catchy). I’ve already posted a series of articles about HG2. Today I wish to discuss an undocumented aspect of HG2 that I’ve encountered several times over the past months, and most recently today. The problem is that while in the previous HG1 system (R2014a and earlier) we could add property-change listener callbacks to practically any graphics object, this is no longer true for HG2. Many graphics properties, that are calculated on-the-fly based on other property values, cannot be listened-to, and so we cannot attach callbacks that trigger when their values change.

Property-change listeners in HG1

Take for example my post about setting axes tick labels format from 3 years ago: the idea there was to attach a Matlab callback function to the PropertyPostSet event of the XTick, YTick and/or ZTick properties, so that when they change their values (upon zoom/pan/resize), the corresponding tick-labels would be reformatted based on the user-specified format:

A simple HG1 usage might look as follows:

addlistener(handle(hAxes), 'YTick', 'PostSet', @reformatTickLabels);
function reformatTickLabels(hProperty, eventData)
    try
        hAxes = eventData.AffectedObject;
    catch
        hAxes = ancestor(eventData.Source,'Axes');
    end
    tickValues = get(hAxes, 'YTick');
    tickLabels = arrayfun(@(x)(sprintf('%.1fV',x)), tickValues, 'UniformOutput',false);
    set(hAxes, 'YTickLabel', tickLabels)
end

I prepared a utility called ticklabelformat that automates much of the set-up above. Feel free to download this utility from the Matlab File Exchange. Its usage syntax is as follows:

ticklabelformat(gca,'y','%.6g V')  % sets y axis on current axes to display 6 significant digits
ticklabelformat(gca,'xy','%.2f')   % sets x & y axes on current axes to display 2 decimal digits
ticklabelformat(gca,'z',@myCbFcn)  % sets a function to update the Z tick labels on current axes
ticklabelformat(gca,'z',{@myCbFcn,extraData})  % sets an update function as above, with extra data

Property-change listeners in HG2

Unfortunately, this fails in HG2 when trying to listen to automatically-recalculated (non-Observable) properties such as the Position or axes Tick properties. We can only listen to non-calculated (Observable) properties such as Tag or YLim. Readers might think that this answers the need, since the ticks change when the axes limits change. This is true, but does not cover all cases. For example, when we resize/maximize the figure, Matlab may decide to modify the displayed ticks, although the axes limits remain unchanged.
So we need to have a way to monitor changes even in auto-calculated properties. Luckily this can be done by listening to a set of new undocumented HG2 events. It turns out that HG2’s axes (matlab.graphics.axis.Axes objects) have no less than 17 declared events, and 14 of them are hidden in R2015a:

>> events(gca)   % list the non-hidden axes events
Events for class matlab.graphics.axis.Axes:
    ObjectBeingDestroyed
    PropertyAdded
    PropertyRemoved
>> mc = metaclass(gca)
mc =
  GraphicsMetaClass with properties:
                     Name: 'matlab.graphics.axis.Axes'
              Description: 'TODO: Fill in Description'
      DetailedDescription: ''
                   Hidden: 0
                   Sealed: 1
                 Abstract: 0
              Enumeration: 0
          ConstructOnLoad: 1
         HandleCompatible: 1
          InferiorClasses: {0x1 cell}
        ContainingPackage: [1x1 meta.package]
             PropertyList: [414x1 meta.property]
               MethodList: [79x1 meta.method]
                EventList: [17x1 meta.event]
    EnumerationMemberList: [0x1 meta.EnumeratedValue]           SuperclassList: [7x1 meta.class]
>> mc.EventList(10)
ans =
  event with properties:
                   Name: 'MarkedClean'
            Description: 'description'
    DetailedDescription: 'detailed description'
                 Hidden: 1
           NotifyAccess: 'public'
           ListenAccess: 'public'
          DefiningClass: [1x1 matlab.graphics.internal.GraphicsMetaClass]
>> [{mc.EventList.Name}; ...
    {mc.EventList.ListenAccess}; ...
    arrayfun(@mat2str, [mc.EventList.Hidden], 'Uniform',false)]'
ans =
    'LocationChanged'             'public'       'true'
    'SizeChanged'                 'public'       'true'
    'ClaReset'                    'public'       'true'
    'ClaPreReset'                 'public'       'true'
    'Cla'                         'public'       'true'
    'ObjectBeingDestroyed'        'public'       'false'  % not hidden
    'Hit'                         'public'       'true'
    'LegendableObjectsUpdated'    'public'       'true'
    'MarkedDirty'                 'public'       'true'
    'MarkedClean'                 'public'       'true'
    'PreUpdate'                   'protected'    'true'
    'PostUpdate'                  'protected'    'true'
    'Error'                       'public'       'true'
    'Reparent'                    'public'       'true'
    'Reset'                       'public'       'true'
    'PropertyAdded'               'public'       'false'  % not hidden
    'PropertyRemoved'             'public'       'false'  % not hidden

Similar hidden events exist for all HG2 graphics objects. The MarkedDirty and MarkedClean events are available for practically all graphic objects. We can listen to them (luckily, their ListenAccess meta-property is defined as ‘public’) to get a notification whenever the corresponding object (axes, or any other graphics component such as a plot-line or axes ruler etc.) is being redrawn. We can then refresh our own properties. It makes sense to attach such callbacks to MarkedClean rather than MarkedDirty, because the property values are naturally stabled and reliable only after MarkedClean. In some specific cases, we might wish to listen to one of the other events, which luckily have meaningful names.
For example, in my ticklabelformat utility I’ve implemented the following code (simplified here for readability – download the utility to see the actual code), which listens to the MarkedClean event on the axes’ YRuler property:

try
    % HG1 (R2014a or older)
    hAx = handle(hAxes);
    hProp = findprop(hAx, 'YTick');
    hListener = handle.listener(hAx, hProp, 'PropertyPostSet', @reformatTickLabels);
    setappdata(hAxes, 'YTickListener', hListener);  % must be persisted in order to remain in effect
catch
    % HG2 (R2014b or newer)
    addlistener(hAx, 'YTick', 'PostSet', @reformatTickLabels);
    % *Tick properties don't trigger PostSet events when updated automatically in R2014b
    %addlistener(hAx, 'YLim', 'PostSet', @reformatTickLabels);  % this solution does not cover all use-cases
    addlistener(hAx.YRuler, 'MarkedClean', @reformatTickLabels);
end
% Adjust tick labels now
reformatTickLabels(hAxes);

In some cases, the triggered event might pass some useful information in the eventData object that is passed to the callback function as the second input parameter. This data may be different for different events, and is also highly susceptible to changes across Matlab releases, so use with care. I believe that the event names themselves (MarkedClean etc.) are less susceptible to change across Matlab releases, but they might.

Performance aspects

The MarkedClean event is triggered numerous times, from obvious triggers such as calling drawnow to less-obvious triggers such as resizing the figure or modifying a plot-line’s properties. We therefore need to be very careful that our callback function is (1) non-reentrant, (2) is not active too often (e.g., more than 5 times per sec), (3) does not modify properties unnecessarily, and in general (4) executes as fast as possible. For example:

function reformatTickLabels(hProperty, eventData)
    persistent inCallback
    if ~isempty(inCallback),  return;  end
    inCallback = 1;  % prevent callback re-entry (not 100% fool-proof)
    % Update labels only every 0.2 secs or more
    persistent lastTime
    try
        tnow = datenummx(clock);  % fast
    catch
        tnow = now;  % slower
    end
    ONE_SEC = 1/24/60/60;
    if ~isempty(lastTime) && tnow - lastTime < 0.2*ONE_SEC
        inCallback = [];  % re-enable callback
        return;
    end
    lastTime = tnow;
    % This is the main callback logic
    try
        hAxes = eventData.AffectedObject;
    catch
        hAxes = ancestor(eventData.Source,'Axes');
    end
    prevTickValues = getappdata(hAxes, 'YTick');
    tickValues = get(hAxes, 'YTick');
    if ~isequal(prevTickValues, tickValues)
        tickLabels = arrayfun(@(x)(sprintf('%.1fV',x)), tickValues, 'UniformOutput',false);
        set(hAxes, 'YTickLabel', tickLabels)
    end
    inCallback = [];  % re-enable callback
end

Unfortunately, it seems that retrieving some property values (such as the axes’s YTick values) may by itself trigger the MarkedClean event for some reason that eludes my understanding (why should merely getting the existing values modify the graphics in any way?). Adding callback re-entrancy checks as above might alleviate the pain of such recursive callback invocations.
A related performance aspect is that it could be better to listen to a sub-component’s MarkedClean than to the parent axes’ MarkedClean, which might be triggered more often, for changes that are entirely unrelated to the sub-component that we wish to monitor. For example, if we only monitor YRuler, then it makes no sense to listen to the parent axes’ MarkedClean event that might trigger due to a change in the XRuler.
In some cases, it may be better to listen to specific events rather than the all-encompassing MarkedClean. For example, if we are only concerned about changes to the Position property, we should listen to the LocationChanged and/or SizeChanged events (more details).
Additional graphics-related performance tips can be found in my Accelerating MATLAB Performance book.
Have you used MarkedClean or some other undocumented HG2 event in your code for some nice effect? If so, please share your experience in a comment below.

18 Responses

Yaroslav May 28, 2015 at 01:21 Reply

The HG2 axes events became hidden in version R2015a. In my R2014b they are visible:

>> events(gca)
Events for class matlab.graphics.axis.Axes:
    LocationChanged
    SizeChanged
    ClaReset
    ClaPreReset
    Cla
    ObjectBeingDestroyed
    Hit
    LegendableObjectsUpdated
    MarkedDirty
    MarkedClean
    Error
    Reparent
    Reset
    PropertyAdded
    PropertyRemoved

I recall making use of the Hit event on several occasions. IMHO, it is the most useful event in the list. Can’t see why TMW decided to hide it in the latest release.

The only hidden events in R2014b are PreUpdate and PostUpdate, which have a protected Observable value:

>> mc = metaclass(gca);
>> [{mc.EventList.Name}; ...
    {mc.EventList.ListenAccess}; ...
    arrayfun(@mat2str, [mc.EventList.Hidden], 'Uniform',false)]'
ans = 
    'LocationChanged'             'public'       'false'
    'SizeChanged'                 'public'       'false'
    'ClaReset'                    'public'       'false'
    'ClaPreReset'                 'public'       'false'
    'Cla'                         'public'       'false'
    'ObjectBeingDestroyed'        'public'       'false'
    'Hit'                         'public'       'false'
    'LegendableObjectsUpdated'    'public'       'false'
    'MarkedDirty'                 'public'       'false'
    'MarkedClean'                 'public'       'false'
    'PreUpdate'                   'protected'    'false'
    'PostUpdate'                  'protected'    'false'
    'Error'                       'public'       'false'
    'Reparent'                    'public'       'false'
    'Reset'                       'public'       'false'
    'PropertyAdded'               'public'       'false'
    'PropertyRemoved'             'public'       'false'

Yair Altman May 28, 2015 at 01:25 Reply

@Yaroslav – thanks. It would be useful to hear how and why you’ve used the Hit event.
Yaroslav May 28, 2015 at 01:56 Reply
@Yair — let’s examine a minimal working example:
ax=axes('NextPlot','add'); addlistener(ax,'Hit',@(obj,evd)plot(evd.IntersectionPoint(1),evd.IntersectionPoint(2),'ob'));
ax=axes('NextPlot','add'); addlistener(ax,'Hit',@(obj,evd)plot(evd.IntersectionPoint(1),evd.IntersectionPoint(2),'ob'));
It plots a point on the axes each time it is hit. One could argue that the ButtonDownFcn property does the same thing. Yet, upon closer inspection, under the hood ButtonDownFcn uses Hit to operate:
ax.ButtonDownFcn = @(obj,evd)display(evd);
ax.ButtonDownFcn = @(obj,evd)display(evd);
<Clicks on the axes>
evd = Hit with properties: Button: 1 IntersectionPoint: [0.4223 0.3771 0] Source: [1x1 Axes] EventName: 'Hit'
evd = Hit with properties: Button: 1 IntersectionPoint: [0.4223 0.3771 0] Source: [1x1 Axes] EventName: 'Hit'
If one needs only a single callback, I guess that ButtonDownFcn will suffice. If there is a necessity for more than one, Hit is invaluable.
Thomas September 14, 2016 at 10:52 Reply

Hey thanks, i will use ‘Hit’!

Vlad Atanasiu May 31, 2015 at 07:18 Reply
Hello Yair,

You contributed to this discussion https://www.mathworks.com/matlabcentral/newsreader/view_thread/283529 on how to change event listening of such toolbar objects as zoom or pan. The solution consisted in using
set(hManager.WindowListenerHandles,'Enable','off');
set(hManager.WindowListenerHandles,'Enable','off');
FYI it appears however that in R2014b modifying WindowListenerHandles is not possible: its SetAccess property is set to protected. Additionally, the former property Enable, a string ( ‘on’ | ‘off’ ), is now called Enabled and has become a scalar ( 0|1 ). Try:
hManager = uigetmodemanager(gcf); mc = metaclass(hManager) mc.PropertyList(5)
hManager = uigetmodemanager(gcf); mc = metaclass(hManager) mc.PropertyList(5)
Thanks, Vlad

Yair Altman May 31, 2015 at 07:55 Reply

@Vlad – that post is 5 years old and used undocumented/unsupported functionality. What’s surprising is not that it finally broke in R2014b, but that it kept working for so long. You can’t expect undocumented/unsupported functionality to keep working forever.

Specifically, R2014b broke quite a lot of undocumented features in its change of the graphics system (HG2). In most cases, things that broke have similarly-undocumented (or documented) equivalents in HG2, you just need to dig around a bit to discover them. The hard part was discovering the initial undocumented features in HG1; finding their equivalents in HG2 should be much easier.

Good luck!

Daniel June 2, 2015 at 02:42 Reply
While it seems like you can prevent re-entry with
persistent inCallback if ~isempty(inCallback), return; end inCallback = 1; % disable callback re-entrancy
persistent inCallback if ~isempty(inCallback), return; end inCallback = 1; % disable callback re-entrancy
since MATLAB timers run asynchronously and can execute between any two lines of code, if a timer callback occurs between the check and setting of inCallback, then you can get re-entry if the timer callback either calls reformatTickLabels or flushes the event queue and reformatTickLabels is in the event queue. I think to be safe you would need to do the check and setting of inCallback atomically, possibly with a mex file.

Yair Altman June 2, 2015 at 03:53 Reply

@Daniel – I agree that an atomic (mutexed) test-and-set function would be better, although in practice the probability of reentrancy with the above code is low. If you create such a MEX-based function and post it on the Matlab File Exchange , I’ll be happy to reference it in this blog.

Nick November 2, 2016 at 23:40 Reply

I’ve been trying to find a way to prevent our users from deleting axes when they are deleting annotations. (This happens way more than I expected, and it is a major source of frustration). I thought it’d be easy to find an event or callback to hook into and pop up a dialog, but it’s proven fairly difficult for me to crack.

I thought maybe I could set a listener for ObjectBeingDestroyed, but it fires after the object is gone (or there’s a synch issue).

Is there some kind of ObjectAboutToBeDestroyed or DestroyObjectRequest thats double-secret-undocumented?

Any thoughts as to how I can hook into this behavior (or as a welcomed alternative, turn off the ability to delete axes with the keyboard – I mean seriously, why is that even a thing?)

function testAxesDelete
    hs = struct('fig', figure);
    hs.fig.MenuBar = 'none';
    hs.fig.ToolBar = 'figure';
    hs.fig.KeyPressFcn = @myKeyCallback;
 
    hs.ax = axes;
    hs.line = plot([0 0], [-1 1]);
 
    hs.ax.DeleteFcn = @myDeleteCallback;
    hs.ax.ButtonDownFcn = @myButtonCallback;
 
    addlistener(hs.ax, 'ObjectBeingDestroyed', @obdCallback);    
end
 
function myKeyCallback(hobj, event, varargin)
    disp('Pressed a key on figure!');
    disp('Axes still is deleted if you press delete with the axis selected');
    disp('Axis is deleted prior to executing this function')
    keyboard
end
 
function myDeleteCallback(hobj, event, varargin)
    disp('Deleting axes!');
    disp('Axis is deleted prior to executing this function')
    keyboard
end
 
function myButtonCallback(hobj, event, varargin)
    disp('Does not intercept delete key');
    keyboard
end
 
function obdCallback(hobj, event, varargin)
    disp('Object being destroyed callback');
    disp('this happens *after* the axes have been deleted ');
    keyboard
end

Yair Altman November 3, 2016 at 08:57 Reply
@Nick –
set(gca,'HitTest','off')
set(gca,'HitTest','off')
Nick November 3, 2016 at 15:25 Reply

You are my hero – thank you for this invaluable resource. And thank you for pointing me to an (embarrassed) *documented* feature.

Cheers!
Nick November 3, 2016 at 18:48 Reply

I just learned a fun fact: plotting to an axes object who’s HitTest property is set to ‘off’ appears to reset HitTest to ‘on’

Yair Altman November 3, 2016 at 19:07

@Nick – this is a “known” undocumented side-effect of using the high-level plotting functions (such as plot), which reset several axes properties including HitTest and Tag. In contrast, the low-level plotting functions (such as line) do not reset these properties.
Nick November 3, 2016 at 20:05

Yair – It looks like setting the Axes ‘NextPlot’ property to ‘add’ may prevent the resetting of HitTest. There is more behavior to investigate, but at least I seem to be on some kind of path. Thank you again

Tucker Downs May 17, 2021 at 07:21 Reply

Hi Yair,

Is “markedClean” still your recommendation for wanting to redraw graphics primitive like objects? I’m working on trying to make some native-like graphics objects and need to know when to redraw.

Also, are you still looking for window transforms / data2pixel and its inverse? I have some info that you might find helpful. Will be posting code soon.

-Tucker

Yair Altman May 17, 2021 at 23:15 Reply

@Tucker – AFAIK markedClean still works even in the very latest release. In recent years MathWorks added a few documented hooks for trapping axes updates etc., but the markedClean event still seems to be a general common mechanism.
If and when you have some information on the transforms, then please let me know.

Adam D Danz June 3, 2021 at 19:44 Reply

Yair, thanks for your unmatched contributions to exploring Matlab under the hood.

I noticed that listeners responding to MarkedClean in geoaxes throw an error even though MarkedClean appears to have public ListenAccess.

ax = geoaxes('basemap','satellite');
MC = metaclass(ax);
E = MC.EventList;
E(10)
 
 GraphicsMetaEvent with properties:
 
    HasCallbackProperty: 0
                   Name: 'MarkedClean'
            Description: 'description'
    DetailedDescription: 'detailed description'
                 Hidden: 1
           NotifyAccess: 'public'
           ListenAccess: 'public'  &lt;--------
          DefiningClass: [1×1 matlab.graphics.internal.GraphicsMetaClass]

But when assigning a listener to geoaxes,

addlistener(ax,'MarkedClean', ...
    'PostSet', @(a,b)myFunc(a,b));
 
Error using matlab.graphics.axis.GeographicAxes/addlistener
The name 'MarkedDirty' is not an accessible property for an instance of class 'matlab.graphics.axis.GeographicAxes'.

I’ve used this type of listener in other axes without problem but I don’t understand what’s blocking it with geoaxes.

Adam D Danz June 3, 2021 at 20:57 Reply
Opps…. I was using the wrong syntax: MarkedClean is an EventName and I was accidentally treating it as a PropertyName. Also, ignore the “MarkedDirty” reference in the error message which was in response to a different version of the listener. #NewbieMistake

The first syntax below is the correct one to use with MarkedClean, as Yair demonstrated in this blog post.
el = addlistener(hSource, EventName, callback) el = addlistener(hSource, PropertyName, EventName, callback)
el = addlistener(hSource, EventName, callback) el = addlistener(hSource, PropertyName, EventName, callback)

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 13 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 (51 days 23 hours ago): @Ken – I cannot reproduce your report, it works as expected for me even on R2022b
Yair Altman (52 days 2 hours ago): try to use the waitfor function
Danila Berezin (56 days 14 hours ago): Hi I have a similar issue. Did you find a workaround for this?
Ken Johnson (65 days 3 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 18 hours ago): It works perfectly. Thanks so much.
Yair Altman (69 days 23 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 15 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 19 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 19 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 19 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 1 hour 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 13 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 1 hour 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 5 hours ago): In 2018b, you can get the icons by calling [hh,icons,plots,txt] = legend({‘Line 1’});

Property-change listeners in HG1

Property-change listeners in HG2

Performance aspects

Related posts:

18 Responses

Leave a Reply